Skip to content

Cloudflare

Updated View as Markdown

Inspect and manage authorized Cloudflare resources with the commands and permissions you explicitly select.

Example workflows

Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.

List Accounts

Help me with this task in Cloudflare: List Accounts. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.

Explore this command: cloudflare.accounts-list-accounts

Account Details

Help me with this task in Cloudflare: Account Details. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.

Explore this command: cloudflare.accounts-account-details

What you can do (3154)

What you can do

Available commands: 3154 (1532 read, 1622 write). Enable only the commands your application needs.

Command Effect
Heartbeat response — cloudflare.getheartbeat Read
List Accounts — cloudflare.accounts-list-accounts Read
Create an Account — cloudflare.account-creation Write
Delete a specific account — cloudflare.account-deletion Write
Account Details — cloudflare.accounts-account-details Read
Update Account — cloudflare.accounts-update-account Write
List abuse reports against the account — cloudflare.listabusereports Read
List submitted abuse reports — cloudflare.listsubmittedabusereports Read
Get a submitted abuse report — cloudflare.getsubmittedabusereport Read
List emails sent to an abuse report submitter — cloudflare.listsubmittedabusereportemails Read
Check whether a report can be appealed — cloudflare.checkappealeligibility Read
List abuse report emails — cloudflare.listemails Read
List abuse report mitigations — cloudflare.listmitigations Read
Request review on mitigations — cloudflare.requestreview Write
Get an abuse report against the account — cloudflare.getabusereport Read
Per-portal MCP tool-call timeseries — cloudflare.mcp-portals-api-portal-tool-call-timeseries Read
Per-server MCP tool-call timeseries — cloudflare.mcp-portals-api-server-tool-call-timeseries Read
Account-global MCP tool-call timeseries — cloudflare.mcp-portals-api-account-tool-call-timeseries Read
List MCP Portals — cloudflare.mcp-portals-api-list-portals Read
Create a new MCP Portal — cloudflare.mcp-portals-api-create-portals Write
Delete an MCP Portal — cloudflare.mcp-portals-api-delete-portals Write
Read details of an MCP Portal — cloudflare.mcp-portals-api-fetch-gateways Read
Update an MCP Portal — cloudflare.mcp-portals-api-update-portals Write
Resolve an MCP server OAuth redirect URI — cloudflare.mcp-portals-api-effective-redirect-uri Read
List MCP Servers — cloudflare.mcp-portals-api-list-servers Read
Create a new MCP Server — cloudflare.mcp-portals-api-create-servers Write
Delete an MCP Server — cloudflare.mcp-portals-api-delete-servers Write
Read the details of an MCP Server — cloudflare.mcp-portals-api-fetch-servers Read
Update an MCP Server — cloudflare.mcp-portals-api-update-servers Write
Sync MCP Server Capabilities — cloudflare.mcp-portals-api-sync-server Write
List Access applications — cloudflare.access-applications-list-access-applications Read
Add an Access application — cloudflare.access-applications-add-an-application Write
List short-lived certificate CAs — cloudflare.access-short-lived-certificate-c-as-list-short-lived-certificate-c-as Read
Delete a short-lived certificate CA — cloudflare.access-short-lived-certificate-c-as-delete-a-short-lived-c-53df2aaf7d Write
Get a short-lived certificate CA — cloudflare.access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca Read
Create a short-lived certificate CA — cloudflare.access-short-lived-certificate-c-as-create-a-short-lived-c-21a6dd88cb Write
List Access application policies — cloudflare.access-policies-list-access-app-policies Read
Create an Access application policy — cloudflare.access-policies-create-an-access-policy Write
Delete an Access application policy — cloudflare.access-policies-delete-an-access-policy Write
Get an Access application policy — cloudflare.access-policies-get-an-access-policy Read
Update an Access application policy — cloudflare.access-policies-update-an-access-policy Write
Convert an Access application policy to a reusable policy — cloudflare.access-policies-convert-reusable Write
List authenticator device AAGUIDs — cloudflare.access-authenticator-device-aaguids-list Read
List mTLS certificates — cloudflare.access-mtls-authentication-list-mtls-certificates Read
Add an mTLS certificate — cloudflare.access-mtls-authentication-add-an-mtls-certificate Write
List all mTLS hostname settings — cloudflare.access-mtls-authentication-list-mtls-certificates-hostname-settings Read
Update an mTLS certificate's hostname settings — cloudflare.access-mtls-authentication-update-an-mtls-certificate-settings Write
Delete an mTLS certificate — cloudflare.access-mtls-authentication-delete-an-mtls-certificate Write
Get an mTLS certificate — cloudflare.access-mtls-authentication-get-an-mtls-certificate Read
Update an mTLS certificate — cloudflare.access-mtls-authentication-update-an-mtls-certificate Write
List custom pages — cloudflare.access-custom-pages-list-custom-pages Read
Create a custom page — cloudflare.access-custom-pages-create-a-custom-page Write
Validate a custom page template — cloudflare.access-custom-pages-validate-a-custom-page-template Write
Delete a custom page — cloudflare.access-custom-pages-delete-a-custom-page Write
Get a custom page — cloudflare.access-custom-pages-get-a-custom-page Read
Update a custom page — cloudflare.access-custom-pages-update-a-custom-page Write
List SSH Certificate Authorities (CA) — cloudflare.access-gateway-ca-list-ssh-ca Read
Add a new SSH Certificate Authority (CA) — cloudflare.access-gateway-ca-add-an-ssh-ca Write
Delete an SSH Certificate Authority (CA) — cloudflare.access-gateway-ca-delete-an-ssh-ca Write
List Access groups — cloudflare.access-groups-list-access-groups Read
Create an Access group — cloudflare.access-groups-create-an-access-group Write
Delete an Access group — cloudflare.access-groups-delete-an-access-group Write
Get an Access group — cloudflare.access-groups-get-an-access-group Read
Update an Access group — cloudflare.access-groups-update-an-access-group Write
List Access identity providers — cloudflare.access-identity-providers-list-access-identity-providers Read
Add an Access identity provider — cloudflare.access-identity-providers-add-an-access-identity-provider Write
Delete an Access identity provider — cloudflare.access-identity-providers-delete-an-access-identity-provider Write
Get an Access identity provider — cloudflare.access-identity-providers-get-an-access-identity-provider Read
Update an Access identity provider — cloudflare.access-identity-providers-update-an-access-identity-provider Write
Create SAML encryption certificate for Identity Provider — cloudflare.access-identity-providers-create-saml-certificate-for-iden-2f0afb5921 Write
List SCIM Group resources — cloudflare.access-identity-providers-list-scim-group-resources Read
Delete a SCIM Group resource — cloudflare.access-identity-providers-delete-scim-group-resource Write
Get a SCIM Group resource — cloudflare.access-identity-providers-get-scim-group-resource Read
List SCIM User resources — cloudflare.access-identity-providers-list-scim-user-resources Read
Delete a SCIM User resource — cloudflare.access-identity-providers-delete-scim-user-resource Write
Get a SCIM User resource — cloudflare.access-identity-providers-get-scim-user-resource Read
List IdP federation grants — cloudflare.access-idp-federation-grants-list Read
Create an IdP federation grant — cloudflare.access-idp-federation-grants-create Write
Delete an IdP federation grant — cloudflare.access-idp-federation-grants-delete Write
Get an IdP federation grant — cloudflare.access-idp-federation-grants-get Read
Get the Access key configuration — cloudflare.access-key-configuration-get-the-access-key-configuration Read
Update the Access key configuration — cloudflare.access-key-configuration-update-the-access-key-configuration Write
Rotate Access keys — cloudflare.access-key-configuration-rotate-access-keys Write
Get Access authentication logs — cloudflare.access-authentication-logs-get-access-authentication-logs Read
List Access JIT request logs — cloudflare.access-jit-request-logs-list Read
Get an Access JIT request log — cloudflare.access-jit-request-logs-get Read
List Access SCIM update logs — cloudflare.access-scim-update-logs-list-access-scim-update-logs Read
Get your Zero Trust organization — cloudflare.zero-trust-organization-get-your-zero-trust-organization Read
Create your Zero Trust organization — cloudflare.zero-trust-organization-create-your-zero-trust-organization Write
Update your Zero Trust organization — cloudflare.zero-trust-organization-update-your-zero-trust-organization Write
Get your Zero Trust organization DoH settings — cloudflare.zero-trust-organization-get-your-zero-trust-organization-doh-settings Read
Update your Zero Trust organization DoH settings — cloudflare.zero-trust-organization-update-your-zero-trust-organizatio-c7ffe55106 Write
Revoke all Access tokens for a user — cloudflare.zero-trust-organization-revoke-all-access-tokens-for-a-user Write
Delete Zero Trust organization trust settings — cloudflare.zero-trust-organization-delete-trust-settings Write
Get Zero Trust organization trust settings — cloudflare.zero-trust-organization-get-trust-settings Read
Update Zero Trust organization trust settings — cloudflare.zero-trust-organization-update-trust-settings Write
Replace Zero Trust organization trust settings — cloudflare.zero-trust-organization-replace-trust-settings Write
List Access reusable policies — cloudflare.access-policies-list-access-reusable-policies Read
Create an Access reusable policy — cloudflare.access-policies-create-an-access-reusable-policy Write
Delete an Access reusable policy — cloudflare.access-policies-delete-an-access-reusable-policy Write
Get an Access reusable policy — cloudflare.access-policies-get-an-access-reusable-policy Read
Update an Access reusable policy — cloudflare.access-policies-update-an-access-reusable-policy Write
Start Access policy test — cloudflare.access-policy-tests Write
Get the current status of a given Access policy test — cloudflare.access-policy-tests-get-an-update Read
Get an Access policy test users page — cloudflare.access-policy-tests-get-a-user-page Read
List SAML certificate sets — cloudflare.access-saml-certificates-list-certificate-sets Read
Get SAML certificate set — cloudflare.access-saml-certificates-get-certificate-set Read
Download current certificate in PEM format — cloudflare.access-saml-certificates-get-pem Read
Rotate SAML certificate — cloudflare.access-saml-certificates-rotate-certificate Write
Update a user seat — cloudflare.zero-trust-seats-update-a-user-seat Write
List service tokens — cloudflare.access-service-tokens-list-service-tokens Read
Create a service token — cloudflare.access-service-tokens-create-a-service-token Write
Delete a service token — cloudflare.access-service-tokens-delete-a-service-token Write
Get a service token — cloudflare.access-service-tokens-get-a-service-token Read
Update a service token — cloudflare.access-service-tokens-update-a-service-token Write
Refresh a service token — cloudflare.access-service-tokens-refresh-a-service-token Write
Rotate a service token — cloudflare.access-service-tokens-rotate-a-service-token Write
List tags — cloudflare.access-tags-list-tags Read
Create a tag — cloudflare.access-tags-create-tag Write
Delete a tag — cloudflare.access-tags-delete-a-tag Write
Get a tag — cloudflare.access-tags-get-a-tag Read
Update a tag — cloudflare.access-tags-update-a-tag Write
List user populations — cloudflare.access-user-populations-list-user-populations Read
Create a user population — cloudflare.access-user-populations-create-user-population Write
Delete a user population — cloudflare.access-user-populations-delete-user-population Write
Get a user population — cloudflare.access-user-populations-get-user-population Read
Update a user population — cloudflare.access-user-populations-update-user-population Write
List users in a user population — cloudflare.access-user-populations-list-users Read
Create a user population user — cloudflare.access-user-populations-create-user Write
Delete a user population user — cloudflare.access-user-populations-delete-user Write
Get a user population user — cloudflare.access-user-populations-get-user Read
Update a user population user — cloudflare.access-user-populations-update-user Write
Replace a user population user — cloudflare.access-user-populations-replace-user Write
Get users — cloudflare.zero-trust-users-get-users Read
Create a user — cloudflare.zero-trust-users-create-user Write
Delete a user — cloudflare.zero-trust-users-delete-user Write
Get a user — cloudflare.zero-trust-users-get-user Read
Update a user — cloudflare.zero-trust-users-update-user Write
Get active sessions — cloudflare.zero-trust-users-get-active-sessions Read
Get single active session — cloudflare.zero-trust-users-get-active-session Read
Get failed logins — cloudflare.zero-trust-users-get-failed-logins Read
Get last seen identity — cloudflare.zero-trust-users-get-last-seen-identity Read
Delete a user's authenticator — cloudflare.zero-trust-users-delete-mfa-authenticator Write
Delete a user's passkey — cloudflare.zero-trust-users-delete-passkey Write
List Address Maps — cloudflare.ip-address-management-address-maps-list-address-maps Read
Create Address Map — cloudflare.ip-address-management-address-maps-create-address-map Write
Delete Address Map — cloudflare.ip-address-management-address-maps-delete-address-map Write
Address Map Details — cloudflare.ip-address-management-address-maps-address-map-details Read
Update Address Map — cloudflare.ip-address-management-address-maps-update-address-map Write
Remove an account membership from an Address Map — cloudflare.ip-address-management-address-maps-remove-an-account-membe-50c3d1b2c5 Write
Add an account membership to an Address Map — cloudflare.ip-address-management-address-maps-add-an-account-membersh-c09c729fdc Write
Remove Multiple IPs from an Address Map — cloudflare.ip-address-management-address-maps-remove-multiple-ips-fro-d3aaba0685 Write
Add Multiple IPs to an Address Map — cloudflare.ip-address-management-address-maps-add-multiple-ips-to-an-address-map Write
Remove an IP from an Address Map — cloudflare.ip-address-management-address-maps-remove-an-ip-from-an-address-map Write
Add an IP to an Address Map — cloudflare.ip-address-management-address-maps-add-an-ip-to-an-address-map Write
Remove Multiple Zones from an Address Map — cloudflare.ip-address-management-address-maps-remove-multiple-zones-f-5db05ad215 Write
Add Multiple Zones to an Address Map — cloudflare.ip-address-management-address-maps-add-multiple-zones-to-a-8db8398e99 Write
Remove a zone membership from an Address Map — cloudflare.ip-address-management-address-maps-remove-a-zone-membershi-3d71ec9d92 Write
Add a zone membership to an Address Map — cloudflare.ip-address-management-address-maps-add-a-zone-membership-t-bd46173fe2 Write
List Leases — cloudflare.ip-address-management-list-leases Read
List LOA Documents — cloudflare.ip-address-management-prefixes-list-loa-documents Read
List Prefixes — cloudflare.ip-address-management-prefixes-list-prefixes Read
Add Prefix — cloudflare.ip-address-management-prefixes-add-prefix Write
Delete Prefix — cloudflare.ip-address-management-prefixes-delete-prefix Write
Prefix Details — cloudflare.ip-address-management-prefixes-prefix-details Read
Update Prefix Description — cloudflare.ip-address-management-prefixes-update-prefix-description Write
List BGP Prefixes — cloudflare.ip-address-management-prefixes-list-bgp-prefixes Read
Create BGP Prefix — cloudflare.ip-address-management-prefixes-create-bgp-prefix Write
Delete BGP Prefix — cloudflare.ip-address-management-prefixes-delete-bgp-prefix Write
Fetch BGP Prefix — cloudflare.ip-address-management-prefixes-fetch-bgp-prefix Read
Update BGP Prefix — cloudflare.ip-address-management-prefixes-update-bgp-prefix Write
List Service Bindings — cloudflare.ip-address-management-service-bindings-list-service-bindings Read
Create Service Binding — cloudflare.ip-address-management-service-bindings-create-service-binding Write
Delete Service Binding — cloudflare.ip-address-management-service-bindings-delete-service-binding Write
Get Service Binding — cloudflare.ip-address-management-service-bindings-get-service-binding Read
List Prefix Delegations — cloudflare.ip-address-management-prefix-delegation-list-prefix-delegations Read
Create Prefix Delegation — cloudflare.ip-address-management-prefix-delegation-create-prefix-delegation Write
Delete Prefix Delegation — cloudflare.ip-address-management-prefix-delegation-delete-prefix-delegation Write
Validate Prefix — cloudflare.ip-address-management-prefixes-validate-prefix Write
List Regions — cloudflare.dls-account-regional-hostnames-list-regions Read
List Services — cloudflare.ip-address-management-service-bindings-list-services Read
Get credit balance — cloudflare.aig-billing-get-credit-balance Read
Get invoice history — cloudflare.aig-billing-get-invoice-history Read
Get invoice preview — cloudflare.aig-billing-get-invoice-preview Read
Delete spending limit (deprecated) — cloudflare.aig-billing-delete-spending-limit Write
Get spending limit (deprecated) — cloudflare.aig-billing-get-spending-limit Read
Create a top-up — cloudflare.aig-billing-create-topup Write
Delete auto top-up configuration — cloudflare.aig-billing-delete-topup-config Write
Get auto top-up configuration — cloudflare.aig-billing-get-topup-config Read
Set auto top-up configuration — cloudflare.aig-billing-set-topup-config Write
Get top-up eligibility — cloudflare.aig-billing-topup-eligibility Write
Get account top-up limits — cloudflare.aig-billing-get-topup-limits Read
Check top-up status — cloudflare.aig-billing-check-topup-status Write
Get usage history — cloudflare.aig-billing-get-usage-history Read
List custom providers — cloudflare.aig-config-list-account-provider Read
Create a custom provider — cloudflare.aig-config-create-account-provider Write
List custom provider pricing rules — cloudflare.aig-config-list-account-provider-cost Read
Create a custom provider pricing rule — cloudflare.aig-config-create-account-provider-cost Write
Delete a custom provider pricing rule — cloudflare.aig-config-delete-account-provider-cost Write
Get a custom provider pricing rule — cloudflare.aig-config-fetch-account-provider-cost Read
Update a custom provider pricing rule — cloudflare.aig-config-update-account-provider-cost Write
Delete a custom provider — cloudflare.aig-config-delete-account-provider Write
Get a custom provider — cloudflare.aig-config-fetch-account-provider Read
Update a custom provider — cloudflare.aig-config-update-account-provider Write
List evaluator types (deprecated) — cloudflare.aig-config-list-evaluators Read
List gateways — cloudflare.aig-config-list-gateway Read
Create a gateway — cloudflare.aig-config-create-gateway Write
List custom domains — cloudflare.aig-config-list-custom-domain Read
Create a custom domain for a gateway — cloudflare.aig-config-create-custom-domain Write
Delete a custom domain — cloudflare.aig-config-delete-custom-domain Write
Get a custom domain — cloudflare.aig-config-fetch-custom-domain Read
List datasets (deprecated) — cloudflare.aig-config-list-dataset Read
Create a dataset (deprecated) — cloudflare.aig-config-create-dataset Write
Delete a dataset (deprecated) — cloudflare.aig-config-delete-dataset Write
Get a dataset (deprecated) — cloudflare.aig-config-fetch-dataset Read
Update a dataset (deprecated) — cloudflare.aig-config-update-dataset Write
List evaluations (deprecated) — cloudflare.aig-config-list-evaluations Read
Create an evaluation (deprecated) — cloudflare.aig-config-create-evaluations Write
Delete an evaluation (deprecated) — cloudflare.aig-config-delete-evaluations Write
Get an evaluation (deprecated) — cloudflare.aig-config-fetch-evaluations Read
Delete Gateway Logs — cloudflare.aig-config-delete-gateway-logs Write
List Gateway Logs — cloudflare.aig-config-list-gateway-logs Read
Get Gateway Log Detail — cloudflare.aig-config-get-gateway-log-detail Read
Patch Gateway Log — cloudflare.aig-config-patch-gateway-log Write
Get Gateway Log Request — cloudflare.aig-config-get-gateway-log-request Read
Get Gateway Log Response — cloudflare.aig-config-get-gateway-log-response Read
List provider keys — cloudflare.aig-config-list-providers Read
Store a provider key — cloudflare.aig-config-create-providers Write
Delete a provider key — cloudflare.aig-config-delete-providers Write
Get a provider key — cloudflare.aig-config-fetch-providers Read
Rotate a provider key — cloudflare.aig-config-update-providers Write
List dynamic routes — cloudflare.aig-config-list-gateway-dynamic-routes Read
Create a dynamic route — cloudflare.aig-config-post-gateway-dynamic-route Write
Delete a dynamic route — cloudflare.aig-config-delete-gateway-dynamic-route Write
Get a dynamic route — cloudflare.aig-config-get-gateway-dynamic-route Read
Rename a dynamic route — cloudflare.aig-config-update-gateway-dynamic-route Write
List dynamic route deployments — cloudflare.aig-config-list-gateway-dynamic-route-deployments Read
Deploy a dynamic route version — cloudflare.aig-config-post-gateway-dynamic-route-deployment Write
List dynamic route versions — cloudflare.aig-config-list-gateway-dynamic-route-versions Read
Create a dynamic route version — cloudflare.aig-config-post-gateway-dynamic-route-version Write
Get a dynamic route version — cloudflare.aig-config-get-gateway-dynamic-route-version Read
Get Gateway URL — cloudflare.aig-config-get-gateway-url Read
Delete a gateway — cloudflare.aig-config-delete-gateway Write
Get a gateway — cloudflare.aig-config-fetch-gateway Read
Update a gateway — cloudflare.aig-config-update-gateway Write
Get AI Gateway logging state — cloudflare.aig-config-get-logging-state Read
Migrate AI Gateway logging to Workers Observability — cloudflare.aig-config-patch-logging-state Write
List namespaces — cloudflare.ai-search-list-namespaces Read
Create a namespace — cloudflare.ai-search-create-namespace Write
List AI Search instances. — cloudflare.ai-search-namespace-list-instances Read
Create an AI Search instance. — cloudflare.ai-search-namespace-create-instance Write
Delete an AI Search instance. — cloudflare.ai-search-namespace-delete-instance Write
Get an AI Search instance. — cloudflare.ai-search-namespace-fetch-instance Read
Move an instance to a different namespace. — cloudflare.ai-search-move-instance Write
Update an AI Search instance. — cloudflare.ai-search-namespace-update-instance Write
Chat Completions — cloudflare.ai-search-namespace-instance-chat-completion Write
Items List. — cloudflare.ai-search-namespace-instance-list-items Read
Create or Update Item. — cloudflare.ai-search-namespace-instance-create-or-update-item Write
Delete Item. — cloudflare.ai-search-namespace-instance-delete-item Write
Get Item. — cloudflare.ai-search-namespace-instance-get-item Read
Sync Item. — cloudflare.ai-search-namespace-instance-sync-item Write
List Item Chunks. — cloudflare.ai-search-namespace-instance-list-item-chunks Read
Item Logs. — cloudflare.ai-search-namespace-instance-logs-item Read
List Jobs — cloudflare.ai-search-namespace-instance-list-jobs Read
Create new job — cloudflare.ai-search-namespace-instance-create-job Write
Get a Job Details — cloudflare.ai-search-namespace-instance-get-job Read
Cancel an indexing job. — cloudflare.ai-search-namespace-instance-change-job-status Write
List Job Logs — cloudflare.ai-search-namespace-instance-list-job-logs Read
Purge search cache. — cloudflare.ai-search-namespace-purge-instance-cache Write
Search — cloudflare.ai-search-namespace-instance-search Write
Get instance statistics. — cloudflare.ai-search-namespace-stats Read
Delete a namespace — cloudflare.ai-search-delete-namespace Write
Get a namespace — cloudflare.ai-search-fetch-namespace Read
Update a namespace — cloudflare.ai-search-update-namespace Write
Multi-Instance Chat Completions — cloudflare.ai-search-namespace-multi-instance-chat-completion Write
Multi-Instance Search — cloudflare.ai-search-namespace-multi-instance-search Write
List tokens — cloudflare.ai-search-list-tokens Read
Create a token — cloudflare.ai-search-create-tokens Write
Delete a token — cloudflare.ai-search-delete-tokens Write
Get a token — cloudflare.ai-search-fetch-tokens Read
Update a token — cloudflare.ai-search-update-tokens Write
Author Search — cloudflare.workers-ai-search-author Read
List Finetunes — cloudflare.workers-ai-list-finetunes Read
Create a new Finetune — cloudflare.workers-ai-create-finetune Write
List Public Finetunes — cloudflare.workers-ai-list-public-finetunes Read
Delete a Finetune — cloudflare.workers-ai-delete-finetune Write
Download a Finetune Asset — cloudflare.workers-ai-download-finetune-asset Read
Get an AI model's input and output schemas — cloudflare.workers-ai-get-model-schema Read
Model Search — cloudflare.workers-ai-search-model Read
Run an AI model with request options — cloudflare.workers-ai-post-run-generic Write
Task Search — cloudflare.workers-ai-search-task Read
List supported Markdown conversion formats — cloudflare.workers-ai-get-to-markdown-supported Read
Search the web through AI Gateway — cloudflare.workers-ai-ai-gateway-web-search Write
Get Alert Types — cloudflare.notification-alert-types-get-alert-types Read
Get delivery mechanism eligibility — cloudflare.notification-mechanism-eligibility-get-delivery-mechanism-eligibility Read
Delete PagerDuty Services — cloudflare.notification-destinations-with-pager-duty-delete-pager-duty-services Write
List PagerDuty services — cloudflare.notification-destinations-with-pager-duty-list-pager-duty-services Read
Create PagerDuty integration token — cloudflare.notification-destinations-with-pager-duty-connect-pager-duty Write
Connect PagerDuty — cloudflare.notification-destinations-with-pager-duty-connect-pager-duty-token Read
List webhooks — cloudflare.notification-webhooks-list-webhooks Read
Create a webhook — cloudflare.notification-webhooks-create-a-webhook Write
Delete a webhook — cloudflare.notification-webhooks-delete-a-webhook Write
Get a webhook — cloudflare.notification-webhooks-get-a-webhook Read
Update a webhook — cloudflare.notification-webhooks-update-a-webhook Write
List History — cloudflare.notification-history-list-history Read
List Notification policies — cloudflare.notification-policies-list-notification-policies Read
Delete a Notification policy — cloudflare.notification-policies-delete-a-notification-policy Write
Get a Notification policy — cloudflare.notification-policies-get-a-notification-policy Read
Update a Notification policy — cloudflare.notification-policies-update-a-notification-policy Write
Show email unsubscribe details — cloudflare.notification-policies-show-email-unsubscribe-details Read
Unsubscribe email from a Notification policy — cloudflare.notification-policies-unsubscribe-email-from-notification-policy Write
Test a Notification policy — cloudflare.notification-policies-test-a-notification-policy Write
List Silences — cloudflare.notification-silences-list-silences Read
Create Silences — cloudflare.notification-silences-create-silences Write
Update Silences — cloudflare.notification-silences-update-silences Write
Delete Silence — cloudflare.notification-silences-delete-silences Write
Get Silence — cloudflare.notification-silences-get-silence Read
Top integrations by content findings — cloudflare.data-security-content-findings-top-n Write
Data security findings summary — cloudflare.data-security-findings-summary Write
Data security findings timeseries — cloudflare.data-security-findings-timeseries Write
Query analytics summary — cloudflare.art-analytics-query-summary Write
Query analytics timeseries — cloudflare.art-analytics-query-timeseries Write
Query analytics top-N — cloudflare.art-analytics-query-top-n Write
Query analytics datasets — cloudflare.sql-api-query-get-account-scoped Read
Query analytics datasets — cloudflare.sql-api-query-post-account-scoped Write
List available analytics datasets — cloudflare.sql-api-introspection-account-scoped Read
Execute an Analytics Engine SQL query via query parameter — cloudflare.analytics-engine-sql-query-get Read
Get count of zones with Argo Smart Routing enabled for account — cloudflare.argo-smart-routing-get-count-zones-enabled-for-account Read
List namespaces — cloudflare.artifacts_namespaces_list Read
Create a namespace — cloudflare.artifacts_namespaces_create Write
Delete a namespace — cloudflare.artifacts_namespaces_delete Write
Get a namespace — cloudflare.artifacts_namespaces_get Read
List repositories — cloudflare.artifacts_repos_list Read
Create a repository — cloudflare.artifacts_repos_create Write
Delete a repository — cloudflare.artifacts_repos_delete Write
Get a repository — cloudflare.artifacts_repos_get Read
Read a Git commit — cloudflare.artifacts_repos_commit_get Read
Fork a repository — cloudflare.artifacts_repos_fork Write
Import a repository — cloudflare.artifacts_repos_import Write
Read commit history — cloudflare.artifacts_repos_log_get Read
Read a raw file with content type — cloudflare.artifacts_repos_raw_get Read
List repository tokens — cloudflare.artifacts_repo_tokens_list Read
Read a Git tree — cloudflare.artifacts_repos_tree_get Read
Create a repository token — cloudflare.artifacts_tokens_create Write
Get account audit logs — cloudflare.audit-logs-get-account-audit-logs Read
AI Search — cloudflare.autorag-config-ai-search Write
Files — cloudflare.autorag-config-files Read
List Jobs — cloudflare.autorag-config-list-jobs Read
Get a Job Details — cloudflare.autorag-config-get-job Read
List Job Logs — cloudflare.autorag-config-list-job-logs Read
Search — cloudflare.autorag-config-search Write
Sync — cloudflare.autorag-config-sync Write
List Basin Catalogs — cloudflare.basin-list-catalogs Read
Get Basin Catalog details — cloudflare.basin-get-catalog-details Read
Store catalog credentials — cloudflare.basin-store-credentials Write
Get Basin Catalog credential status — cloudflare.basin-get-credential-status Read
Delete Basin Catalog metadata — cloudflare.basin-delete-catalog Write
Disable Basin Catalog — cloudflare.basin-disable-catalog Write
Enable R2 bucket as a catalog — cloudflare.basin-enable-catalog Write
Get catalog maintenance configuration — cloudflare.basin-get-maintenance-config Read
Update catalog maintenance configuration — cloudflare.basin-update-maintenance-config Write
List namespaces in catalog — cloudflare.basin-list-namespaces Read
List tables in namespace — cloudflare.basin-list-tables Read
Get table details — cloudflare.basin-get-table Read
Get table maintenance configuration — cloudflare.basin-get-table-maintenance-config Read
Update table maintenance configuration — cloudflare.basin-update-table-maintenance-config Write
Queue table maintenance — cloudflare.basin-queue-table-maintenance Write
List table maintenance runs — cloudflare.basin-list-table-maintenance-runs Read
Get Account Billable Usage (Version 1, Alpha) — cloudflare.billable-usage-get-v1-account-usage Read
Get Account Billable Usage Info (Version 1, Alpha) — cloudflare.billable-usage-get-v1-account-usage-info Read
Get Account Usage (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-get-account-usage Read
Query Account Usage (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-query-account-usage Write
List Account Billable Metrics (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-get-account-billable-metrics Read
Get Account Bad Debt — cloudflare.account-billing-get-bad-debt Read
Get Account Credits — cloudflare.account-billing-get-credits Read
Get Account Billing History — cloudflare.account-billing-history-get-billing-history Read
Delete Billing Profile — cloudflare.account-billing-profile-delete-billing-profile Write
Get Billing Profile — cloudflare.account-billing-profile-get-billing-profile Read
Update Billing Email — cloudflare.account-billing-profile-update-billing-email Write
Create Billing Profile — cloudflare.account-billing-profile-create-billing-profile Write
Update Billing Profile — cloudflare.account-billing-profile-update-billing-profile Write
Create Payment Intent for Billing Profile — cloudflare.account-billing-create-payment-intent Write
List Spend Policies — cloudflare.spend-policies-list Read
Create Spend Policy — cloudflare.spend-policies-create Write
List Spend Policy Activity — cloudflare.spend-policies-activity Read
Delete Spend Policy — cloudflare.spend-policies-delete Write
Get Spend Policy — cloudflare.spend-policies-get Read
Update Spend Policy — cloudflare.spend-policies-update Write
List Spend Policy Audit Entries — cloudflare.spend-policies-list-audit Read
Get Unpaid Invoices — cloudflare.account-billing-get-unpaid-invoices Read
Get account billing usage — cloudflare.usage-analytics-get-account-billing-usage Read
Get daily report — cloudflare.botnet-threat-feed-get-day-report Read
Get full report — cloudflare.botnet-threat-feed-get-full-report Read
Get list of ASNs — cloudflare.botnet-threat-feed-list-asn Read
Delete an ASN — cloudflare.botnet-threat-feed-delete-asn Write
Read matches for logo queries by ID — cloudflare.getaccountsaccountidbrandprotectionlogomatches Read
Download matches for logo queries by ID — cloudflare.getaccountsaccountidbrandprotectionlogomatchesdownload Read
Delete saved logo queries by ID — cloudflare.deleteaccountsaccountidbrandprotectionlogoslogoid Write
Read matches for string queries by ID — cloudflare.getaccountsaccountidbrandprotectionmatches Read
Download matches for string queries by ID — cloudflare.getaccountsaccountidbrandprotectionmatchesdownload Read
Delete saved string queries by ID — cloudflare.deleteaccountsaccountidbrandprotectionqueries Write
Create new saved string queries — cloudflare.postaccountsaccountidbrandprotectionqueries Write
Create new saved string queries in bulk — cloudflare.postaccountsaccountidbrandprotectionqueriesbulk Write
Create new URL submissions — cloudflare.postaccountsaccountidbrandprotectionsubmit Write
Read submitted URLs by ID — cloudflare.getaccountsaccountidbrandprotectionurlinfo Read
Delete browser extension configuration — cloudflare.accounts-browser-extension-config-delete Write
Get browser extension configuration — cloudflare.accounts-browser-extension-config-get Read
Create browser extension configuration — cloudflare.accounts-browser-extension-config-post Write
Update browser extension configuration — cloudflare.accounts-browser-extension-config-put Write
List browser extension inventories — cloudflare.accounts-browser-extension-inventories-list Read
Get a single browser extension inventory — cloudflare.accounts-browser-extension-inventories-get Read
Search browser extension event logs — cloudflare.accounts-browser-extension-config-extension-events-search Write
Query browser extension event timeseries — cloudflare.accounts-browser-extension-config-extension-events-timeseries Write
Get accessibility tree page — cloudflare.brapi-post_accessibilitytree Write
Get HTML content. — cloudflare.brapi-post_content Write
Crawl websites. — cloudflare.brapi-post_crawl Write
Cancel a crawl job. — cloudflare.brapi-delete_cancelcrawl Write
Get crawl result. — cloudflare.brapi-get_crawlresult Read
Get a browser session ID. — cloudflare.brapi-post_devtoolsacquire Write
Close browser session. — cloudflare.brapi-delete_devtoolsbrowserdelete Write
List targets. — cloudflare.brapi-get_devtoolsjson Read
Activate a browser target. — cloudflare.brapi-get_devtoolsjsonactivate Read
Close a browser target. — cloudflare.brapi-get_devtoolsjsonclose Read
List targets. — cloudflare.brapi-get_devtoolsjsonlist Read
Get a target by ID. — cloudflare.brapi-get_devtoolsjsontarget Read
Open a new browser tab. — cloudflare.brapi-put_devtoolsjsonnew Write
Get Chrome DevTools Protocol schema. — cloudflare.brapi-get_devtoolsjsonprotocol Read
Get browser version metadata. — cloudflare.brapi-get_devtoolsjsonversion Read
Mint live view URLs for a browser session — cloudflare.brapi-post_devtoolsliveview Write
List sessions. — cloudflare.brapi-get_devtoolssessionlist Read
Get session details. — cloudflare.brapi-get_devtoolssessiondetails Read
Get json. — cloudflare.brapi-post_json Write
Get Links. — cloudflare.brapi-post_links Write
Get markdown. — cloudflare.brapi-post_markdown Write
Get PDF. — cloudflare.brapi-post_pdf Write
Get recording data. — cloudflare.brapi-get_recording Read
Get network recording data. — cloudflare.brapi-get_recordingnetwork Read
Scrape elements. — cloudflare.brapi-post_scrape Write
Get screenshot. — cloudflare.brapi-post_screenshot Write
Get HTML content and screenshot. — cloudflare.brapi-post_snapshot Write
Get build-minute availability — cloudflare.getaccountlimits Read
Get builds by Worker version — cloudflare.getbuildsbyversionids Read
Get latest builds by script IDs — cloudflare.getlatestbuildsbyscripts Read
Get a Workers build — cloudflare.getbuildbyuuid Read
Cancel a Workers build — cloudflare.cancelbuildbyuuid Write
Get Workers build logs — cloudflare.getbuildlogs Read
Create or update a repository connection — cloudflare.upsertrepoconnection Write
Delete a repository connection — cloudflare.deleterepoconnection Write
Get repository configuration autofill — cloudflare.getworkerconfigautofill Read
List build tokens — cloudflare.listbuildtokens Read
Create build token — cloudflare.createbuildtoken Write
Delete a build token — cloudflare.deletebuildtoken Write
Create a build trigger — cloudflare.createtrigger Write
Delete a build trigger — cloudflare.deletetrigger Write
Update a build trigger — cloudflare.updatetrigger Write
Start a Workers build — cloudflare.createmanualbuild Write
List build variables — cloudflare.listenvironmentvariables Read
Set build variables — cloudflare.upsertenvironmentvariables Write
Delete a build variable — cloudflare.deleteenvironmentvariable Write
Purge a trigger's build cache — cloudflare.purgebuildcache Write
Create Worker build configuration — cloudflare.createworkerbuild Write
List builds for a Worker — cloudflare.listbuildsbyscript Read
List triggers for a Worker — cloudflare.listtriggersbyscript Read
List deploy hooks — cloudflare.listdeployhooks Read
Create a deploy hook — cloudflare.createdeployhook Write
Delete a deploy hook — cloudflare.deletedeployhook Write
Get a deploy hook — cloudflare.getdeployhook Read
Update a deploy hook — cloudflare.updatedeployhook Write
Delete Worker build configuration — cloudflare.deleteworkerbuild Write
Get Worker build configuration — cloudflare.getworkerbuild Read
Migrate worker to previews — cloudflare.migrateworkertopreviews Write
List previews — cloudflare.listworkerpreviews Read
Get preview — cloudflare.getworkerpreview Read
List builds by preview — cloudflare.listbuildsbypreview Read
Create preview build — cloudflare.createpreviewbuild Write
Create Subscriptions — cloudflare.account-subscriptions-bulk-create-subscription Write
List apps — cloudflare.calls-apps-list Read
Create an SFU app — cloudflare.calls-apps-create-a-new-app Write
Delete an SFU app — cloudflare.calls-apps-delete-app Write
Retrieve SFU app details — cloudflare.calls-apps-retrieve-app-details Read
Update SFU app details — cloudflare.calls-apps-update-app-details Write
List TURN keys — cloudflare.calls-turn-key-list Read
Create a TURN key — cloudflare.calls-turn-key-create Write
Delete TURN key — cloudflare.calls-delete-turn-key Write
Retrieve TURN key details — cloudflare.calls-retrieve-turn-key-details Read
Update TURN key details — cloudflare.calls-update-turn-key Write
List Cloudflare Tunnels — cloudflare.cloudflare-tunnel-list-cloudflare-tunnels Read
Create a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-create-a-cloudflare-tunnel Write
Delete a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-delete-a-cloudflare-tunnel Write
Get a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-get-a-cloudflare-tunnel Read
Update a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-update-a-cloudflare-tunnel Write
Get Tunnel configuration — cloudflare.cloudflare-tunnel-configuration-get-configuration Read
Update Tunnel configuration — cloudflare.cloudflare-tunnel-configuration-put-configuration Write
Clean up Cloudflare Tunnel connections — cloudflare.cloudflare-tunnel-clean-up-cloudflare-tunnel-connections Write
List Cloudflare Tunnel connections — cloudflare.cloudflare-tunnel-list-cloudflare-tunnel-connections Read
Get Cloudflare Tunnel connector — cloudflare.cloudflare-tunnel-get-cloudflare-tunnel-connector Read
Get a Cloudflare Tunnel management token — cloudflare.cloudflare-tunnel-get-a-cloudflare-tunnel-management-token Write
Get a Cloudflare Tunnel token — cloudflare.cloudflare-tunnel-get-a-cloudflare-tunnel-token Read
List Turnstile Widgets — cloudflare.accounts-turnstile-widgets-list Read
Create a Turnstile Widget — cloudflare.accounts-turnstile-widget-create Write
Delete a Turnstile Widget — cloudflare.accounts-turnstile-widget-delete Write
Turnstile Widget Details — cloudflare.accounts-turnstile-widget-get Read
Update a Turnstile Widget — cloudflare.accounts-turnstile-widget-update Write
Rotate Secret for a Turnstile Widget — cloudflare.accounts-turnstile-widget-rotate-secret Write
Create Setup Intent — cloudflare.account-billing-create-setup-intent Write
Get the Latest Banner Grab Result — cloudflare.get_getbanners Read
Retrieves a file from Binary Storage — cloudflare.get_bindbgetbinary Read
List events — cloudflare.get_eventlistget Read
Search events — cloudflare.post_eventlist Write
Aggregate events — cloudflare.get_eventaggregate Read
List attackers — cloudflare.get_attackerlist Read
List related events — cloudflare.get_eventrelationships Read
List event categories used in datasets — cloudflare.get_categorylist Read
List all event categories — cloudflare.get_categorylistcomplete Read
Create an event category — cloudflare.post_categorycreate Write
List countries — cloudflare.get_countryread Read
Create an event — cloudflare.post_eventcreate Write
Create events in bulk — cloudflare.post_eventcreatebulk Write
List datasets — cloudflare.get_datasetlist Read
List account groups — cloudflare.get_grouplist Read
Create an account group — cloudflare.post_groupcreate Write
Delete an account group — cloudflare.delete_groupdelete Write
Get an account group — cloudflare.get_groupread Read
Update an account group — cloudflare.put_groupupdate Write
List group members — cloudflare.get_groupmemberlist Read
Add an account to a group — cloudflare.post_groupmembercreate Write
Remove an account from a group — cloudflare.delete_groupmemberdelete Write
Create a dataset — cloudflare.post_datasetcreate Write
Delete a dataset — cloudflare.delete_datasetdelete Write
Get a dataset — cloudflare.get_datasetread Read
Update a dataset — cloudflare.patch_datasetupdate Write
Update a dataset — cloudflare.post_datasetupdate Write
Copy events to another dataset — cloudflare.post_eventcopytonewds Write
Get an event — cloudflare.get_eventread Read
Create an indicator type — cloudflare.post_indicatortypecreate Write
Delete indicators in bulk — cloudflare.delete_indicatordeletebulk Write
Create indicators in bulk — cloudflare.post_indicatorcreatebulk Write
Create an indicator — cloudflare.post_indicatorcreate Write
List tags on a dataset's indicators — cloudflare.get_indicatortagslist Read
Delete an indicator — cloudflare.delete_indicatordelete Write
Get an indicator — cloudflare.get_indicatorread Read
Update an indicator — cloudflare.patch_indicatorupdate Write
List indicator relationships — cloudflare.get_indicatorrelationshipslist Read
Create an indicator relationship — cloudflare.post_indicatorrelationshipcreate Write
Delete an indicator relationship — cloudflare.delete_indicatorrelationshipdelete Write
Update an indicator relationship — cloudflare.patch_indicatorrelationshipupdate Write
Move events to another dataset — cloudflare.post_eventmovetonewds Write
List dataset permissions — cloudflare.get_permissionlist Read
Grant access to a dataset — cloudflare.post_permissioncreate Write
Revoke access to a dataset — cloudflare.delete_permissiondelete Write
Change a dataset permission — cloudflare.put_permissionupdate Write
List target industries in a dataset (legacy) — cloudflare.get_targetindustrylistbydataset Read
Rebuild dataset lookup lists — cloudflare.post_datasetpopulate Write
Delete events — cloudflare.delete_eventdelete Write
Get raw data for an event — cloudflare.get_eventrawreadds Read
Delete an event category — cloudflare.delete_categorydelete Write
Get an event category — cloudflare.get_categoryread Read
Update an event category — cloudflare.patch_categoryupdate Write
Update an event category — cloudflare.post_categoryupdate Write
Remove tags from an event (legacy) — cloudflare.delete_eventtagdelete Write
Add tags to an event (legacy) — cloudflare.post_eventtagcreate Write
Query graph neighborhood from R2 Data Catalog — cloudflare.get_eventgraph Read
Run a GraphQL aggregation over events — cloudflare.post_eventgraphql Write
List indicator types — cloudflare.get_indicatortypeslist Read
List indicators — cloudflare.get_indicatorlist Read
Aggregate indicators by column(s) — cloudflare.get_indicatoraggregate Read
List saved event queries — cloudflare.get_eventquerylist Read
Create a saved event query — cloudflare.post_eventquerycreate Write
Delete a saved event query — cloudflare.delete_eventquerydelete Write
Get a saved event query — cloudflare.get_eventqueryread Read
Update a saved event query — cloudflare.patch_eventqueryupdate Write
Update a saved event query — cloudflare.post_eventqueryupdate Write
Remove event references (legacy) — cloudflare.delete_eventreferencedelete Write
Add event references (legacy) — cloudflare.post_eventreferencecreate Write
Create event relationships — cloudflare.post_createeventrelationship Write
Delete a tag category — cloudflare.delete_tagcategorydelete Write
Get a tag category — cloudflare.get_tagcategorydetail Read
Update a tag category — cloudflare.patch_tagcategoryupdate Write
List tags — cloudflare.get_taglist Read
List tag categories — cloudflare.get_tagcategorylist Read
List threat actors — cloudflare.get_taggedactorlist Read
Create a tag category — cloudflare.post_tagcategorycreate Write
Create a tag — cloudflare.post_tagcreate Write
Delete a tag — cloudflare.delete_tagdelete Write
Get a tag — cloudflare.get_tagdetail Read
Update a tag — cloudflare.patch_tagupdate Write
List a tag's indicators — cloudflare.get_tagindicatorslist Read
List tag relationships — cloudflare.get_tagrelationshipslist Read
Create a tag relationship — cloudflare.post_tagrelationshipcreate Write
Delete a tag relationship — cloudflare.delete_tagrelationshipdelete Write
Update a tag relationship — cloudflare.patch_tagrelationshipupdate Write
List target industries used in datasets — cloudflare.get_targetindustrylist Read
List all target industries — cloudflare.get_targetindustrylistcomplete Read
Update events in bulk — cloudflare.patch_eventupdatebulk Write
Update an event — cloudflare.patch_eventupdate Write
Update an event — cloudflare.post_eventupdate Write
Get raw event data by raw ID (legacy) — cloudflare.get_eventrawread Read
Update raw event data by raw ID (legacy) — cloudflare.patch_eventrawupdate Write
Update raw event data by raw ID (legacy) — cloudflare.post_eventrawupdate Write
List Requests — cloudflare.cloudforce-one-request-list Write
Get Request Priority, Status, and TLP constants — cloudflare.cloudforce-one-request-constants Read
Create a New Request. — cloudflare.cloudforce-one-request-new Write
List Priority Intelligence Requirements — cloudflare.cloudforce-one-priority-list Write
Create a New Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-new Write
Get Priority Intelligence Requirement Quota — cloudflare.cloudforce-one-priority-quota Read
Delete a Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-delete Write
Get a Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-get Read
Update a Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-update Write
Get Request Quota — cloudflare.cloudforce-one-request-quota Read
Get Request Types — cloudflare.cloudforce-one-request-types Read
Delete a Request — cloudflare.cloudforce-one-request-delete Write
Get a Request — cloudflare.cloudforce-one-request-get Read
Update a Request — cloudflare.cloudforce-one-request-update Write
List Request Assets — cloudflare.cloudforce-one-request-asset-list Write
Delete a Request Asset — cloudflare.cloudforce-one-request-asset-delete Write
Get a Request Asset — cloudflare.cloudforce-one-request-asset-get Read
Update a Request Asset — cloudflare.cloudforce-one-request-asset-update Write
List Request Messages — cloudflare.cloudforce-one-request-message-list Write
Create a New Request Message — cloudflare.cloudforce-one-request-message-new Write
Delete a Request Message — cloudflare.cloudforce-one-request-message-delete Write
Update a Request Message — cloudflare.cloudforce-one-request-message-update Write
Delete all rules — cloudflare.cloudforce-one-delete-all-rules Write
List rules — cloudflare.cloudforce-one-list-rules Read
Create a rule — cloudflare.cloudforce-one-create-rule Write
List rule approvals — cloudflare.cloudforce-one-list-rule-approvals Read
Get rule approval details — cloudflare.cloudforce-one-get-rule-approval Read
Cancel a pending approval — cloudflare.cloudforce-one-cancel-rule-approval Write
Revise and resubmit a rejected approval — cloudflare.cloudforce-one-resubmit-rule-approval Write
Remove patterns from exemption rules — cloudflare.cloudforce-one-remove-account-exemptions Write
Get exemption rules for an account — cloudflare.cloudforce-one-get-exemptions Read
Add patterns to exemption rules — cloudflare.cloudforce-one-add-account-exemptions Write
Update exemption rule patterns — cloudflare.cloudforce-one-update-account-exemptions Write
Get managed rules — cloudflare.cloudforce-one-get-managed-rules Read
Search rules — cloudflare.cloudforce-one-search-rules Read
Get dashboard stats — cloudflare.cloudforce-one-get-rule-stats Read
List email rules — cloudflare.cloudforce-one-list-email-rules Read
Create an email rule — cloudflare.cloudforce-one-create-email-rule Write
Update a pending structured email rule approval — cloudflare.cloudforce-one-update-pending-email-rule-approval Write
Revise and resubmit a rejected structured email rule approval — cloudflare.cloudforce-one-resubmit-email-rule-approval Write
Get email rule schema — cloudflare.cloudforce-one-get-email-rule-schema Read
Validate an email rule — cloudflare.cloudforce-one-validate-email-rule Write
Delete an email rule — cloudflare.cloudforce-one-delete-email-rule Write
Get an email rule — cloudflare.cloudforce-one-get-email-rule Read
Update an email rule — cloudflare.cloudforce-one-update-email-rule Write
Test an email rule — cloudflare.cloudforce-one-test-email-rule Write
Get folder tree structure — cloudflare.cloudforce-one-get-rule-tree Read
Validate rule with context — cloudflare.cloudforce-one-validate-rule Write
Delete a rule — cloudflare.cloudforce-one-delete-rule Write
Get a rule — cloudflare.cloudforce-one-get-rule Read
Update a rule — cloudflare.cloudforce-one-update-rule Write
List Scan Configs — cloudflare.get_configfetch Read
Create a new Scan Config — cloudflare.post_configcreate Write
Delete a Scan Config — cloudflare.delete_deletescans Write
Update an existing Scan Config — cloudflare.post_configupdate Write
Get the Latest Scan Result — cloudflare.get_getopenports Read
List saved query matches — cloudflare.get_domainmatchlist Read
Bulk dismiss or undismiss matches — cloudflare.post_bulkdismissmatches Write
Get queries — cloudflare.get_getdomainqueries Read
Insert query — cloudflare.post_insertdomainquery Write
Delete domain query — cloudflare.delete_deletedomainquery Write
Update domain query — cloudflare.patch_updatedomainquery Write
Analyze domains for brand impersonation — cloudflare.post_domaintrial Write
Generate takedown letter — cloudflare.post_lettergenerate Write
List letter templates — cloudflare.get_lettertemplatelist Read
Create letter template — cloudflare.post_lettertemplatecreate Write
List example letter templates — cloudflare.get_lettertemplateexamples Read
Delete letter template — cloudflare.delete_lettertemplatedelete Write
Get letter template — cloudflare.get_lettertemplateget Read
Update letter template — cloudflare.put_lettertemplateupdate Write
List logo matches — cloudflare.get_logomatchlist Read
Get logo queries — cloudflare.get_getlogoqueries Read
Insert logo query — cloudflare.post_insertlogoquery Write
Delete logo query — cloudflare.delete_deletelogoquery Write
Search scanned images — cloudflare.post_searchlogosimilarity Write
Dismiss a match — cloudflare.post_dismissmatch Write
Undismiss a match — cloudflare.post_undismissmatch Write
List takedown notices — cloudflare.get_takedownnoticelist Read
Create takedown notice — cloudflare.post_takedownnoticecreate Write
Lookup takedown notices by domains — cloudflare.post_takedownnoticelookup Write
Delete takedown notice — cloudflare.delete_takedownnoticedelete Write
Get takedown notice — cloudflare.get_takedownnoticeget Read
Update takedown notice — cloudflare.put_takedownnoticeupdate Write
List takedown letters — cloudflare.get_takedownletterlist Read
Create takedown letter — cloudflare.post_takedownlettercreate Write
Delete takedown letter — cloudflare.delete_takedownletterdelete Write
Get takedown letter — cloudflare.get_takedownletterget Read
Get total queries — cloudflare.get_totalqueries Read
List collections — cloudflare.get_collectionlist Read
Create a new collection — cloudflare.post_collectioncreate Write
Delete collection — cloudflare.delete_collectiondelete Write
Get collection — cloudflare.get_collectionget Read
Update collection — cloudflare.patch_collectionupdate Write
Add column to collection — cloudflare.post_columnadd Write
Delete column — cloudflare.delete_columndelete Write
Update column — cloudflare.patch_columnupdate Write
Export collection to CSV, JSONL, or Markdown — cloudflare.get_collectionexportendpoint Read
Query collection items — cloudflare.get_itemquery Read
Create item(s) — cloudflare.post_itemcreate Write
Delete collection item — cloudflare.delete_itemdelete Write
Get collection item — cloudflare.get_itemget Read
Update collection item — cloudflare.patch_itemupdate Write
Search items (advanced filtering) — cloudflare.post_itemsearch Write
List monitored domains — cloudflare.get_domainlist Read
Create monitored domain — cloudflare.post_domaincreate Write
Delete monitored domain — cloudflare.delete_domaindelete Write
List credential matches — cloudflare.get_matchlist Read
Run a GraphQL aggregation over events (legacy) — cloudflare.post_eventgraphqlv2 Write
List priority intelligence requirements for an account — cloudflare.get_pirlist Read
Create a priority intelligence requirement — cloudflare.post_pircreate Write
Get PIR constants (methods, dimensions, and TLP values) — cloudflare.get_pirconstants Read
Generate event filters from a PIR — cloudflare.post_pirfiltergenerate Write
List account interests for PIR Option 2 — cloudflare.get_pirinterestlist Read
Create an account interest for PIR Option 2 — cloudflare.post_pirinterestcreate Write
Backtest account-interest change detection — cloudflare.post_pirinterestbacktestcreate Write
Get a persisted account-interest backtest — cloudflare.get_pirinterestbacktestget Read
Evaluate recent event-dated changes for account interests — cloudflare.post_pirinterestevaluationcreate Write
Get a persisted account-interest evaluation — cloudflare.get_pirinterestevaluationget Read
Delete an account interest for PIR Option 2 — cloudflare.delete_pirinterestdelete Write
Update an account interest for PIR Option 2 — cloudflare.patch_pirinterestupdate Write
Count matched events across the account's priority intelligence requirements — cloudflare.get_pirallmatchaggregates Read
Delete the organization profile — cloudflare.delete_pirprofiledelete Write
Get the organization profile — cloudflare.get_pirprofileget Read
Create or replace the organization profile — cloudflare.put_pirprofileput Write
Get PIR quota for an account — cloudflare.post_pirquota Write
Delete a priority intelligence requirement — cloudflare.delete_pirdelete Write
Get a priority intelligence requirement by ID — cloudflare.get_pirget Read
Update a priority intelligence requirement — cloudflare.put_pirupdate Write
List a priority intelligence requirement's matched events — cloudflare.get_pirmatcheslist Read
Triage a priority intelligence requirement's matched events — cloudflare.patch_pirmatchestriage Write
Count a priority intelligence requirement's matched events — cloudflare.get_pirmatchaggregates Read
Count a priority intelligence requirement's matched events per day — cloudflare.get_pirmatchseries Read
Check if current user is allowlisted for Legal Response — cloudflare.get_legalresponseaccesscheck Read
List RFIs — cloudflare.get_requestlist Read
Creates a new RFI — cloudflare.post_requestcreate Write
Get request constants — cloudflare.get_requestconstants Read
List metadata fields for an RFI type — cloudflare.get_dashboardmetadatafieldlist Read
Get request token quota — cloudflare.get_requestquota Read
List visible request types for a project (dashboard) — cloudflare.get_dashboardrequesttypeslist Read
Get current user profile — cloudflare.get_usergetself Read
Get an RFI by ID — cloudflare.get_requestread Read
Update an RFI — cloudflare.put_requestupdate Write
List assets in request (Customer) — cloudflare.get_dashboardassetlist Read
List messages for an RFI request — cloudflare.get_messagelist Read
Create a customer follow-on message on an RFI request — cloudflare.post_messagecreate Write
Read a single message for an RFI request — cloudflare.get_messageread Read
Update/publish a message for an RFI request — cloudflare.put_messageupdate Write
Search threat intelligence — cloudflare.searchthreatintelligence Write
List Threat Signals articles — cloudflare.rssarticlelist Read
Bulk update Threat Signals article read status — cloudflare.rssarticlebulkmarkread Write
Count Threat Signals articles by relevance band — cloudflare.rssarticlerelevanceaggregate Read
Count Threat Signals articles by severity band — cloudflare.rssarticleseverityaggregate Read
Get Threat Signals article — cloudflare.rssarticleget Read
Update Threat Signals article read status — cloudflare.rssarticlemarkread Write
Get Threat Signals article content — cloudflare.rssarticlecontentget Read
Reprocess a Threat Signals article — cloudflare.rssarticlereprocess Write
List Threat Signals article custom skills — cloudflare.rssarticlecustomskillslist Read
Get Threat Signals article skill output — cloudflare.rssarticleskilloutputget Read
Run and persist skill output for a Threat Signals article — cloudflare.rssarticleskillrun Write
Generate Threat Signals article AI tags — cloudflare.rssarticletaggenerate Write
Add tag to Threat Signals article — cloudflare.rssarticletagadd Write
Remove tag from Threat Signals article — cloudflare.rssarticletagremove Write
List Threat Signals feed categories — cloudflare.rssfeedcategorylist Read
List Threat Signals feeds — cloudflare.rssfeedlist Read
Create Threat Signals feed — cloudflare.rssfeedcreate Write
Trigger Threat Signals feed poll — cloudflare.rssfeedpoll Write
Delete Threat Signals feed — cloudflare.rssfeeddelete Write
Update Threat Signals feed — cloudflare.rssfeedupdate Write
Get Threat Signals feed XML — cloudflare.rssfeedrawget Read
Get Threat Signals feed skills — cloudflare.rssfeedskillsget Read
Set Threat Signals feed skills — cloudflare.rssfeedskillsset Write
List Threat Signals article indicators — cloudflare.rssarticleindicatorlist Read
Search Threat Signals articles using AI Search — cloudflare.searchthreatsignals Read
List Threat Signals skills — cloudflare.rssskilllist Read
Create Threat Signals skill — cloudflare.rssskillcreate Write
Delete Threat Signals skill — cloudflare.rssskilldelete Write
Get Threat Signals skill — cloudflare.rssskillget Read
Update Threat Signals skill — cloudflare.rssskillupdate Write
Get Threat Signals skill tag categories — cloudflare.rssskilltagcategoriesget Read
Replace Threat Signals skill tag categories — cloudflare.rssskilltagcategoriesreplace Write
List existing CNI objects — cloudflare.list_cnis Read
Create a new CNI object — cloudflare.create_cni Write
Delete a specified CNI object — cloudflare.delete_cni Write
Get information about a CNI object — cloudflare.get_cni Read
Modify stored information about a CNI object — cloudflare.update_cni Write
List existing interconnects — cloudflare.list_interconnects Read
Create a new interconnect — cloudflare.create_interconnect Write
Delete an interconnect object — cloudflare.delete_interconnect Write
Get information about an interconnect object — cloudflare.get_interconnect Read
Generate the Letter of Authorization (LOA) for a given interconnect — cloudflare.get_interconnect_loa Read
Get the default customer name for LOA generation — cloudflare.get_interconnect_loa_default_name Read
Get the current status of an interconnect object — cloudflare.get_interconnect_status Read
Get the current settings for the active account — cloudflare.get_settings Read
Update the current settings for the active account — cloudflare.update_settings Write
Retrieve a list of all slots matching the specified parameters — cloudflare.list_slots Read
Get information about the specified slot — cloudflare.get_slot Read
List Workers VPC connectivity services — cloudflare.connectivity-services-list Read
Delete Workers VPC connectivity service — cloudflare.connectivity-services-delete Write
Get Workers VPC connectivity service — cloudflare.connectivity-services-get Read
List Applications associated with your account — cloudflare.listapplications Read
Create a new application — cloudflare.createapplication Write
Delete a single application by id — cloudflare.deleteapplication Write
Get a single application by id — cloudflare.getapplication Read
Modify an application — cloudflare.modifyapplication Write
List container instances — cloudflare.listcontainerinstances_v2 Read
Create a new rollout for an application — cloudflare.createapplicationrollout Write
List all application versions — cloudflare.listapplicationversions Read
Prepare a container image — cloudflare.preparecontainerimage Write
Get the list of configured registries in the account — cloudflare.listimageregistries Read
Configure a private external image registry — cloudflare.createimageregistry Write
Delete a registry from the account — cloudflare.deleteimageregistry Write
Generate a JWT to interact with the specified image registry. — cloudflare.generateimageregistrycredentials Write
List Custom CSRs — cloudflare.custom-csrs-for-an-account-list-custom-csrs Read
Create Custom CSR — cloudflare.custom-csrs-for-an-account-create-custom-csr Write
Delete Custom CSR — cloudflare.custom-csrs-for-an-account-delete-custom-csr Write
Custom CSR Details — cloudflare.custom-csrs-for-an-account-custom-csr-details Read
List Account Custom Nameservers — cloudflare.account-level-custom-nameservers-list-account-custom-nameservers Read
Add Account Custom Nameserver — cloudflare.account-level-custom-nameservers-add-account-custom-nameserver Write
Delete Account Custom Nameserver — cloudflare.account-level-custom-nameservers-delete-account-custom-nameserver Write
List custom pages — cloudflare.custom-pages-for-an-account-list-custom-pages Read
List custom assets — cloudflare.custom-assets-for-an-account-list-custom-assets Read
Create a custom asset — cloudflare.custom-assets-for-an-account-create-a-custom-asset Write
Delete a custom asset — cloudflare.custom-assets-for-an-account-delete-a-custom-asset Write
Get a custom asset — cloudflare.custom-assets-for-an-account-get-a-custom-asset Read
Update a custom asset — cloudflare.custom-assets-for-an-account-update-a-custom-asset Write
Create a preview token — cloudflare.custom-pages-for-an-account-create-preview-token Write
Get a custom page — cloudflare.custom-pages-for-an-account-get-a-custom-page Read
Update a custom page — cloudflare.custom-pages-for-an-account-update-a-custom-page Write
List D1 Databases — cloudflare.d1-list-databases Read
Create D1 Database — cloudflare.d1-create-database Write
Delete D1 Database — cloudflare.d1-delete-database Write
Update D1 Database partially — cloudflare.d1-update-partial-database Write
Update D1 Database — cloudflare.d1-update-database Write
Export D1 Database as SQL — cloudflare.d1-export-database Write
Import SQL into your D1 Database — cloudflare.d1-import-database Write
Query D1 Database — cloudflare.d1-query-database Write
Raw D1 Database query — cloudflare.d1-raw-database-query Write
Get D1 database bookmark — cloudflare.d1-time-travel-get-bookmark Read
Restore D1 Database to a bookmark or point in time — cloudflare.d1-time-travel-restore Write
Undelete D1 Database — cloudflare.d1-undelete-database Write
List asset schemas — cloudflare.listassetschemas Read
Get asset schema by asset class — cloudflare.getassetschema Read
List DLP content findings — cloudflare.listcontentassets Read
Create a content export — cloudflare.createcontentexport Write
List all export jobs — cloudflare.listexportjobs Read
List all finding types — cloudflare.listfindingtypes Read
Create a custom finding type — cloudflare.createfindingtype Write
Validate a custom finding type — cloudflare.validatefindingtype Write
Delete a custom finding type — cloudflare.deletefindingtype Write
Get finding by ID — cloudflare.getfindingtype Read
Update a custom finding type — cloudflare.updatefindingtype Write
List remediation types for a finding type — cloudflare.getremediationtypesforfindingtype Read
List posture findings — cloudflare.listfindings Read
Create new findings export request — cloudflare.createfindingexportcsv Write
Mark a finding as ignored — cloudflare.ignorefinding Write
Remove ignore marker from a finding — cloudflare.unignorefinding Write
Get a posture finding — cloudflare.getfinding Read
List instances of a finding — cloudflare.listfindinginstances Read
Archive a finding — cloudflare.archivefindinginstance Write
Remove the archive marking from a finding instance — cloudflare.unarchivefindinginstance Write
Get a finding instance using an instance ID — cloudflare.getfindinginstance Read
Reset severity for a finding back to the default — cloudflare.resetfindingseverity Write
Update the severity for a finding — cloudflare.changefindingseverity Write
Create a finding instances export — cloudflare.createfindinginstancesexportcsv Write
List policy configurations — cloudflare.listpolicies Read
Delete a policy configuration — cloudflare.deletepolicy Write
Get a policy configuration by ID — cloudflare.getpolicybyid Read
List policy invocation logs — cloudflare.listpolicylogentries Read
List remediation jobs — cloudflare.listremediationjobs Read
Creates remediation jobs — cloudflare.createremediationjobs Write
Create a remediation jobs export — cloudflare.createremediationjobsexportcsv Write
List webhook configurations — cloudflare.listwebhooks Read
Create a new webhook configuration — cloudflare.createwebhook Write
Test a webhook configuration before creating it — cloudflare.evaluatenewwebhook Write
Create webhook jobs — cloudflare.createwebhookjobs Write
Delete a webhook configuration — cloudflare.deletewebhook Write
Get webhook configuration by ID — cloudflare.getwebhookconfigbyid Read
Update an existing webhook configuration — cloudflare.updatewebhook Write
Test an existing webhook configuration — cloudflare.evaluateexistingwebhook Write
List client versions — cloudflare.list-client-versions Read
List available target environments — cloudflare.list-client-target-environments Read
List deployment groups — cloudflare.list-deployment-groups Read
Create deployment group — cloudflare.create-deployment-group Write
Delete deployment group — cloudflare.delete-deployment-group Write
Get deployment group — cloudflare.get-deployment-group Read
Update deployment group — cloudflare.update-deployment-group Write
List IP profiles — cloudflare.list-ip-profiles Read
Create IP profile — cloudflare.create-ip-profile Write
Delete IP profile — cloudflare.delete-ip-profile Write
Get IP profile — cloudflare.get-ip-profile Read
Update IP profile — cloudflare.update-ip-profile Write
List your device managed networks — cloudflare.device-managed-networks-list-device-managed-networks Read
Create a device managed network — cloudflare.device-managed-networks-create-device-managed-network Write
Delete a device managed network — cloudflare.device-managed-networks-delete-device-managed-network Write
Get device managed network details — cloudflare.device-managed-networks-device-managed-network-details Read
Update a device managed network — cloudflare.device-managed-networks-update-device-managed-network Write
Generate an uninstall protection override code — cloudflare.create-override-code Write
List devices — cloudflare.list-devices Read
Delete device — cloudflare.delete-device Write
Get device — cloudflare.get-device Read
Update device — cloudflare.patch-device Write
List device settings profiles — cloudflare.devices-list-device-settings-policies Read
Get the default device settings profile — cloudflare.devices-get-default-device-settings-policy Read
Update the default device settings profile — cloudflare.devices-update-default-device-settings-policy Write
Create a device settings profile — cloudflare.devices-create-device-settings-policy Write
Reset Split Tunnel exclude list — cloudflare.devices-delete-split-tunnel-exclude-list Write
Get the Split Tunnel exclude list — cloudflare.devices-get-split-tunnel-exclude-list Read
Set the Split Tunnel exclude list — cloudflare.devices-set-split-tunnel-exclude-list Write
Reset Local Domain Fallback — cloudflare.devices-delete-local-domain-fallback-list Write
Get your Local Domain Fallback list — cloudflare.devices-get-local-domain-fallback-list Read
Set your Local Domain Fallback list — cloudflare.devices-set-local-domain-fallback-list Write
Get the Split Tunnel include list — cloudflare.devices-get-split-tunnel-include-list Read
Set the Split Tunnel include list — cloudflare.devices-set-split-tunnel-include-list Write
Delete a device settings profile — cloudflare.devices-delete-device-settings-policy Write
Get device settings profile by ID — cloudflare.devices-get-device-settings-policy-by-id Read
Update a device settings profile — cloudflare.devices-update-device-settings-policy Write
Reset Split Tunnel exclude list — cloudflare.devices-delete-split-tunnel-exclude-list-for-a-device-settings-policy Write
Get the Split Tunnel exclude list for a device settings profile — cloudflare.devices-get-split-tunnel-exclude-list-for-a-device-settings-policy Read
Set the Split Tunnel exclude list for a device settings profile — cloudflare.devices-set-split-tunnel-exclude-list-for-a-device-settings-policy Write
Reset Local Domain Fallback — cloudflare.devices-delete-local-domain-fallback-list-for-a-device-set-d98d3493e3 Write
Get the Local Domain Fallback list for a device settings profile — cloudflare.devices-get-local-domain-fallback-list-for-a-device-settings-policy Read
Set the Local Domain Fallback list for a device settings profile — cloudflare.devices-set-local-domain-fallback-list-for-a-device-settings-policy Write
Get the Split Tunnel include list for a device settings profile — cloudflare.devices-get-split-tunnel-include-list-for-a-device-settings-policy Read
Set the Split Tunnel include list for a device settings profile — cloudflare.devices-set-split-tunnel-include-list-for-a-device-settings-policy Write
List posture rules — cloudflare.device-posture-rules-list-device-posture-rules Read
Create posture rule — cloudflare.device-posture-rules-create-device-posture-rule Write
List posture integrations — cloudflare.device-posture-integrations-list-device-posture-integrations Read
Delete posture integration — cloudflare.device-posture-integrations-delete-device-posture-integration Write
Get posture integration — cloudflare.device-posture-integrations-device-posture-integration-details Read
Update posture integration — cloudflare.device-posture-integrations-update-device-posture-integration Write
Delete posture rule — cloudflare.device-posture-rules-delete-device-posture-rule Write
Get posture rule — cloudflare.device-posture-rules-device-posture-rules-details Read
Update posture rule — cloudflare.device-posture-rules-update-device-posture-rule Write
Delete registrations — cloudflare.delete-registrations Write
List registrations — cloudflare.list-registrations Read
Delete registration — cloudflare.delete-registration Write
Get registration — cloudflare.get-registration Read
Get override codes — cloudflare.get-registration-override-codes Read
Get Global Disconnect — cloudflare.devices-resilience-retrieve-global-warp-override Read
Set Global Disconnect — cloudflare.devices-resilience-set-global-warp-override Write
Reset device settings — cloudflare.zero-trust-accounts-delete-device-settings-for-zero-trust-account Write
Get device settings — cloudflare.zero-trust-accounts-get-device-settings-for-zero-trust-account Read
Update device settings — cloudflare.zero-trust-accounts-patch-device-settings-for-the-zero-trust-account Write
List Cloudflare colos — cloudflare.dex-endpoints-list-colos Read
List account commands — cloudflare.get-commands Read
Create account commands — cloudflare.post-commands Write
List devices eligible for remote captures — cloudflare.get-commands-eligible-devices Read
Returns account commands usage, quota, and reset time — cloudflare.get-commands-quota Read
List Device DEX tests — cloudflare.device-dex-test-details Read
Create Device DEX test — cloudflare.device-dex-test-create-device-dex-test Write
Delete Device DEX test — cloudflare.device-dex-test-delete-device-dex-test Write
Get Device DEX test — cloudflare.device-dex-test-get-device-dex-test Read
Update Device DEX test — cloudflare.device-dex-test-update-device-dex-test Write
Get the latest status of a device. — cloudflare.devices-live-status Read
Get the status over time for a device — cloudflare.dex-device-status-over-time Read
List device ISPs — cloudflare.dex-endpoints-list-device-isps Read
List details of devices using WARP. — cloudflare.dex-fleet-status-devices Read
Get live aggregate device details by dimension — cloudflare.dex-fleet-status-live Read
Get over time aggregate details for devices by dimension — cloudflare.dex-fleet-status-over-time Read
Get percentiles for an http test — cloudflare.dex-endpoints-http-test-percentiles Read
List DEX Rules — cloudflare.list-dex-rules Read
Create a DEX Rule — cloudflare.create-dex-rule Write
Delete a DEX Rule — cloudflare.delete-dex-rule Write
Get DEX Rule — cloudflare.get-dex-rule Read
Update a DEX Rule — cloudflare.update-dex-rule Write
List DEX test analytics — cloudflare.dex-endpoints-list-tests-overview Read
Get count of devices targeted — cloudflare.dex-endpoints-tests-unique-devices Read
Get details for a specific traceroute test run — cloudflare.dex-endpoints-traceroute-test-result-network-path Read
Get percentiles for a traceroute test — cloudflare.dex-endpoints-traceroute-test-percentiles Read
List WARP change events. — cloudflare.list-warp-change-events Read
List Endpoint Health Checks — cloudflare.diagnostics-endpoint-healthcheck-list Read
Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-create Write
Delete Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-delete Write
Get Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-get Read
Update Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-update Write
Traceroute — cloudflare.diagnostics-traceroute Write
List custom prompt topics — cloudflare.dlp-custom-prompt-topics-list Read
Create custom prompt topic — cloudflare.dlp-custom-prompt-topics-create Write
Delete custom prompt topic — cloudflare.dlp-custom-prompt-topics-delete Write
Get custom prompt topic — cloudflare.dlp-custom-prompt-topics-get Read
Update custom prompt topic — cloudflare.dlp-custom-prompt-topics-update Write
Retrieve all data classes in an account — cloudflare.dlp-data-classes-list Read
Creates a new data class — cloudflare.dlp-data-classes-create Write
Delete a single data class — cloudflare.dlp-data-classes-delete Write
Retrieve a specific data class — cloudflare.dlp-data-classes-read Read
Update the attributes of a single data class — cloudflare.dlp-data-classes-update Write
Retrieve all data tag categories in an account — cloudflare.dlp-data-tag-categories-list Read
Creates a new data tag category. — cloudflare.dlp-data-tag-categories-create Write
Delete a single data tag category. — cloudflare.dlp-data-tag-categories-delete Write
Retrieve a specific data tag category. — cloudflare.dlp-data-tag-categories-read Read
Update the attributes of a single data tag category. — cloudflare.dlp-data-tag-categories-update Write
Retrieve all data tags in a data tag category — cloudflare.dlp-data-tags-list Read
Creates a new data tag. — cloudflare.dlp-data-tags-create Write
Delete a single data tag. — cloudflare.dlp-data-tags-delete Write
Retrieve a specific data tag. — cloudflare.dlp-data-tags-read Read
Update the attributes of a single data tag. — cloudflare.dlp-data-tags-update Write
Retrieve all data tag category templates in an account — cloudflare.dlp-data-tag-category-templates-list Read
Retrieve a specific data tag category template. — cloudflare.dlp-data-tag-category-template-read Read
Fetch all datasets — cloudflare.dlp-datasets-read-all Read
Create a new dataset — cloudflare.dlp-datasets-create Write
Delete a dataset — cloudflare.dlp-datasets-delete Write
Fetch a specific dataset — cloudflare.dlp-datasets-read Read
Update details about a dataset — cloudflare.dlp-datasets-update Write
Prepare to upload a new version of a dataset — cloudflare.dlp-datasets-create-version Write
Sets the column information for a multi-column upload — cloudflare.dlp-datasets-define-columns Write
Retrieve data about all document fingerprints. — cloudflare.dlp-document-fingerprints-read-all Read
Creates a new document fingerprint. — cloudflare.dlp-document-fingerprints-create Write
Delete a single document fingerprint. — cloudflare.dlp-document-fingerprints-delete Write
Retrieve data about a specific document fingerprint. — cloudflare.dlp-document-fingerprints-read Read
Update the attributes of a single document fingerprint. — cloudflare.dlp-document-fingerprints-update Write
Get mapping — cloudflare.dlp-email-scanner-get-account-mapping Read
Create mapping — cloudflare.dlp-email-scanner-create-account-mapping Write
List all email scanner rules — cloudflare.dlp-email-scanner-list-all-rules Read
Update email scanner rule priorities — cloudflare.dlp-email-scanner-update-rule-priorities Write
Create email scanner rule — cloudflare.dlp-email-scanner-create-rule Write
Delete email scanner rule — cloudflare.dlp-email-scanner-delete-rule Write
Get an email scanner rule — cloudflare.dlp-email-scanner-get-rule Read
Update email scanner rule — cloudflare.dlp-email-scanner-update-rule Write
List all entries — cloudflare.dlp-entries-list-all-entries Read
Create custom entry — cloudflare.dlp-entries-create-entry Write
Update custom entry — cloudflare.dlp-entries-update-custom-entry Write
Create integration entry — cloudflare.dlp-entries-create-integration-entry Write
Delete integration entry — cloudflare.dlp-entries-delete-integration-entry Write
Update integration entry — cloudflare.dlp-entries-update-integration-entry Write
Create predefined entry — cloudflare.dlp-entries-create-predefined-entry Write
Delete predefined entry — cloudflare.dlp-entries-delete-predefined-entry Write
Update predefined entry — cloudflare.dlp-entries-update-predefined-entry Write
Delete custom entry — cloudflare.dlp-entries-delete-entry Write
Get DLP Entry — cloudflare.dlp-entries-get-dlp-entry Read
Update entry — cloudflare.dlp-entries-update-entry Write
Fetch limits associated with DLP for account — cloudflare.dlp-limits-get Read
Validate a DLP regex pattern — cloudflare.dlp-pattern-validate Write
List all profiles — cloudflare.dlp-profiles-list-all-profiles Read
List all custom profiles — cloudflare.dlp-profiles-list-all-custom-profiles Read
Create custom profile — cloudflare.dlp-profiles-create-custom-profiles Write
Delete custom profile — cloudflare.dlp-profiles-delete-custom-profile Write
Get custom profile — cloudflare.dlp-profiles-get-custom-profile Read
Update custom profile — cloudflare.dlp-profiles-update-custom-profile Write
Delete integration profile — cloudflare.dlp-profiles-delete-integration-profile Write
List integration profile references — cloudflare.dlp-profiles-list-integration-profile-references Read
Create predefined profile — cloudflare.dlp-profiles-create-predefined-profile Write
Delete predefined profile — cloudflare.dlp-profiles-delete-predefined-profile Write
Get predefined profile — cloudflare.dlp-profiles-get-predefined-profile Read
Update predefined profile — cloudflare.dlp-profiles-update-predefined-profile Write
Get predefined profile config — cloudflare.dlp-profiles-get-predefined-profile-config Read
Create predefined profile — cloudflare.dlp-profiles-create-predefined-profile-config Write
Update predefined profile config — cloudflare.dlp-profiles-update-predefined-profile-config Write
Get DLP Profile — cloudflare.dlp-profiles-get-dlp-profile Read
Retrieve all sensitivity groups in an account — cloudflare.dlp-sensitivity-groups-list Read
Creates a new sensitivity group. — cloudflare.dlp-sensitivity-groups-create Write
Retrieve all sensitivity group templates in an account — cloudflare.dlp-sensitivity-group-templates-list Read
Retrieve a specific sensitivity group template. — cloudflare.dlp-sensitivity-group-template-read Read
Delete a single sensitivity group. — cloudflare.dlp-sensitivity-groups-delete Write
Retrieve a specific sensitivity group. — cloudflare.dlp-sensitivity-groups-read Read
Update the attributes of a single sensitivity group. — cloudflare.dlp-sensitivity-groups-update Write
Retrieve the ordered list of level IDs for a sensitivity group. — cloudflare.dlp-sensitivity-groups-get-level-order Read
Set the ordering of levels within a sensitivity group. — cloudflare.dlp-sensitivity-groups-put-level-order Write
Retrieve all sensitivity levels in a sensitivity group — cloudflare.dlp-sensitivity-levels-list Read
Creates a new sensitivity level. — cloudflare.dlp-sensitivity-levels-create Write
Delete a single sensitivity level. — cloudflare.dlp-sensitivity-levels-delete Write
Retrieve a specific sensitivity level. — cloudflare.dlp-sensitivity-levels-read Read
Update the attributes of a single sensitivity level. — cloudflare.dlp-sensitivity-levels-update Write
Delete (reset) DLP account-level settings to initial values. — cloudflare.dlp-settings-delete Write
Get DLP account-level settings. — cloudflare.dlp-settings-get Read
Partially update DLP account-level settings. — cloudflare.dlp-settings-edit Write
Update DLP account-level settings (full replacement). — cloudflare.dlp-settings-update Write
List validators — cloudflare.dlp-validators-list-validators Read
List proximity word validators — cloudflare.dlp-validators-list-proximity-words-validators Read
Create a proximity word validator — cloudflare.dlp-validators-create-proximity-words-validator Write
Delete a proximity word validator — cloudflare.dlp-validators-delete-proximity-words-validator Write
Get a proximity word validator — cloudflare.dlp-validators-get-proximity-words-validator Read
Update a proximity word validator — cloudflare.dlp-validators-update-proximity-words-validator Write
List worker validators — cloudflare.dlp-validators-list-worker-validators Read
Create a worker validator — cloudflare.dlp-validators-create-worker-validator Write
Delete a worker validator — cloudflare.dlp-validators-delete-worker-validator Write
Get a worker validator — cloudflare.dlp-validators-get-worker-validator Read
Update a worker validator — cloudflare.dlp-validators-update-worker-validator Write
Get a worker validator status — cloudflare.dlp-validators-get-worker-validator-status Read
Get a validator — cloudflare.dlp-validators-get-validator Read
List DLS prefix bindings for an account — cloudflare.publiclistprefixbindings Read
Create a DLS prefix binding — cloudflare.publiccreateprefixbinding Write
Delete a DLS prefix binding — cloudflare.publicdeleteprefixbinding Write
Get a DLS prefix binding — cloudflare.publicgetprefixbinding Read
Update a DLS prefix binding — cloudflare.publicpatchprefixbinding Write
List DLS regions for an account — cloudflare.publiclistregions Read
Get a DLS region — cloudflare.publicgetregion Read
List DNS Firewall Clusters — cloudflare.dns-firewall-list-dns-firewall-clusters Read
Delete DNS Firewall Cluster — cloudflare.dns-firewall-delete-dns-firewall-cluster Write
DNS Firewall Cluster Details — cloudflare.dns-firewall-dns-firewall-cluster-details Read
Update DNS Firewall Cluster — cloudflare.dns-firewall-update-dns-firewall-cluster Write
Show DNS Firewall Cluster Reverse DNS — cloudflare.dns-firewall-show-dns-firewall-cluster-reverse-dns Read
Update DNS Firewall Cluster Reverse DNS — cloudflare.dns-firewall-update-dns-firewall-cluster-reverse-dns Write
Get DNS Record Usage for Account — cloudflare.dns-records-for-an-account-get-usage Read
Show DNS Settings — cloudflare.dns-settings-for-an-account-list-dns-settings Read
Update DNS Settings — cloudflare.dns-settings-for-an-account-update-dns-settings Write
List Custom Nameserver Sets — cloudflare.dns-settings-for-an-account-list-custom-nameserver-sets Read
Create Custom Nameserver Set — cloudflare.dns-settings-for-an-account-create-custom-nameserver-set Write
Delete Custom Nameserver Set — cloudflare.dns-settings-for-an-account-delete-custom-nameserver-set Write
Get Custom Nameserver Set — cloudflare.dns-settings-for-an-account-get-custom-nameserver-set Read
Update Custom Nameserver Set — cloudflare.dns-settings-for-an-account-update-custom-nameserver-set Write
List Internal DNS Views — cloudflare.dns-views-for-an-account-list-internal-dns-views Read
Create Internal DNS View — cloudflare.dns-views-for-an-account-create-internal-dns-views Write
Delete Internal DNS View — cloudflare.dns-views-for-an-account-delete-internal-dns-view Write
DNS Internal View Details — cloudflare.dns-views-for-an-account-get-internal-dns-view Read
Update Internal DNS View — cloudflare.dns-views-for-an-account-update-internal-dns-view Write
Get monthly report — cloudflare.email_security_get_monthly_report Read
Search email messages — cloudflare.email_security_investigate Read
List bulk action jobs — cloudflare.email_security_get_bulk_jobs Read
Create a bulk action job — cloudflare.email_security_create_bulk_job Write
Delete a bulk action job — cloudflare.email_security_delete_bulk_job Write
Get bulk action job details — cloudflare.email_security_get_bulk_job Read
Cancel a bulk action job — cloudflare.email_security_cancel_bulk_job Write
List messages for a bulk action job — cloudflare.email_security_get_bulk_job_messages Read
Move messages — cloudflare.email_security_post_bulk_move Write
Generate preview for a non-detection message — cloudflare.email_security_post_preview Write
Release messages from quarantine — cloudflare.email_security_post_release Write
Get message details — cloudflare.email_security_get_message Read
List post-delivery actions for a message — cloudflare.email_security_get_message_action_log Read
Get message detection details — cloudflare.email_security_get_message_detections Read
Move a message — cloudflare.email_security_post_message_move Write
Get preview for a detection — cloudflare.email_security_get_message_preview Read
Get raw email content — cloudflare.email_security_get_message_raw Read
Get email trace — cloudflare.email_security_get_message_trace Read
List PhishGuard reports — cloudflare.email_security_get_phishguard_reports Read
List email allow policies — cloudflare.email_security_list_allow_policies Read
Create email allow policy — cloudflare.email_security_create_allow_policy Write
Batch allow policy operations — cloudflare.email_security_batch_allow_policies Write
Delete an email allow policy — cloudflare.email_security_delete_allow_policy Write
Get an email allow policy — cloudflare.email_security_get_allow_policy Read
Replace an email allow policy — cloudflare.email_security_replace_allow_policy Write
List blocked email senders — cloudflare.email_security_list_blocked_senders Read
Create blocked email sender — cloudflare.email_security_create_blocked_sender Write
Batch blocked sender operations — cloudflare.email_security_batch_blocked_senders Write
Delete a blocked email sender — cloudflare.email_security_delete_blocked_sender Write
Get a blocked email sender — cloudflare.email_security_get_blocked_sender Read
Replace a blocked email sender — cloudflare.email_security_replace_blocked_sender Write
List content policies — cloudflare.email_security_list_content_policies Read
Create a content policy — cloudflare.email_security_create_content_policy Write
Batch content policy operations — cloudflare.email_security_batch_content_policies Write
Delete a content policy — cloudflare.email_security_delete_content_policy Write
Get a content policy — cloudflare.email_security_get_content_policy Read
List protected email domains — cloudflare.email_security_list_domains Read
Add a new email domain — cloudflare.email_security_create_domains Write
Batch domain operations — cloudflare.email_security_batch_domains Write
Unprotect an email domain — cloudflare.email_security_delete_domain Write
Get an email domain — cloudflare.email_security_get_domain Read
Update an email domain — cloudflare.email_security_update_domain Write
Replace an email domain — cloudflare.email_security_replace_domain Write
Get domain verification details — cloudflare.email_security_get_domain_verification Read
List impersonation registry entries — cloudflare.email_security_list_impersonation_registry Read
Create impersonation registry entry — cloudflare.email_security_create_impersonation_registry Write
Delete an impersonation registry entry — cloudflare.email_security_delete_impersonation_registry Write
Get an impersonation registry entry — cloudflare.email_security_get_impersonation_registry Read
List sending domain restrictions — cloudflare.email_security_list_sending_domain_restrictions Read
Create a sending domain restriction — cloudflare.email_security_create_sending_domain_restriction Write
Batch sending domain restriction operations — cloudflare.email_security_batch_sending_domain_restrictions Write
Delete a sending domain restriction — cloudflare.email_security_delete_sending_domain_restriction Write
Get a sending domain restriction — cloudflare.email_security_get_sending_domain_restriction Read
List trusted email domains — cloudflare.email_security_list_trusted_domains Read
Create trusted email domain — cloudflare.email_security_create_trusted_domain Write
Batch trusted domain operations — cloudflare.email_security_batch_trusted_domains Write
Delete a trusted email domain — cloudflare.email_security_delete_trusted_domain Write
Get a trusted email domain — cloudflare.email_security_get_trusted_domain Read
Replace a trusted email domain — cloudflare.email_security_replace_trusted_domain Write
List URL ignore patterns — cloudflare.email_security_list_url_ignore_patterns Read
Create a URL ignore pattern — cloudflare.email_security_create_url_ignore_pattern Write
Batch URL ignore pattern operations — cloudflare.email_security_batch_url_ignore_patterns Write
Delete a URL ignore pattern — cloudflare.email_security_delete_url_ignore_pattern Write
Get a URL ignore pattern — cloudflare.email_security_get_url_ignore_pattern Read
List reclassify submissions — cloudflare.email_security_submissions Read
Create new submissions — cloudflare.email_security_create_submissions Write
List Email Domain changes — cloudflare.email-domains-changes Read
List Email Domains — cloudflare.email-domains-list Read
Create an Email Domain — cloudflare.email-domains-create Write
Delete an Email Domain — cloudflare.email-domains-delete Write
Get an Email Domain — cloudflare.email-domains-get Read
Verify an Email Domain — cloudflare.email-domains-verify Write
List destination addresses — cloudflare.email-routing-destination-addresses-list-destination-addresses Read
Create a destination address — cloudflare.email-routing-destination-addresses-create-a-destination-address Write
Delete destination address — cloudflare.email-routing-destination-addresses-delete-destination-address Write
Get a destination address — cloudflare.email-routing-destination-addresses-get-a-destination-address Read
Update destination address — cloudflare.email-routing-destination-addresses-update-destination-address Write
List account routing rules — cloudflare.email-routing-routing-rules-list-account-routing-rules Read
Plan account routing rule changes — cloudflare.email-routing-routing-rules-plan-account-routing-rules Write
Get sending limits — cloudflare.email-sending-get-sending-limits Read
Get account reputation — cloudflare.email-sending-get-reputation Read
Send an email — cloudflare.email-sending-account-send-builder Write
Send a raw MIME email — cloudflare.email-sending-account-send-raw-message Write
List account Email Sending suppressions — cloudflare.get_publiclistsendingsuppressions Read
Create account Email Sending suppression — cloudflare.post_publiccreatesendingsuppression Write
Bulk import account Email Sending suppressions — cloudflare.post_publicbulkcreatesendingsuppressions Write
Delete account Email Sending suppression — cloudflare.delete_publicdeletesendingsuppression Write
Get account Email Sending suppression — cloudflare.get_publicgetsendingsuppression Read
Update account Email Sending suppression — cloudflare.patch_publicupdatesendingsuppression Write
Get Account Entitlements — cloudflare.entitlements-get-account-entitlements Read
List Event Notification Rules — cloudflare.r2-get-event-notification-configs Read
List Event Subscriptions — cloudflare.subscriptions-list Read
Create Event Subscription — cloudflare.subscriptions-create Write
Delete Event Subscription — cloudflare.subscriptions-delete Write
Get Event Subscription — cloudflare.subscriptions-get Read
Update Event Subscription — cloudflare.subscriptions-patch Write
Delete Field Extractor — cloudflare.deletefieldextractor Write
Get Field Extractor — cloudflare.getfieldextractor Read
Update Field Extractor — cloudflare.updatefieldextractor Write
List IP Access rules — cloudflare.ip-access-rules-for-an-account-list-ip-access-rules Read
Delete an IP Access rule — cloudflare.ip-access-rules-for-an-account-delete-an-ip-access-rule Write
Get an IP Access rule — cloudflare.ip-access-rules-for-an-account-get-an-ip-access-rule Read
Delete the payload logging key — cloudflare.payload-logging-keys-for-an-account-delete-the-payload-logging-key Write
Get the payload logging key — cloudflare.payload-logging-keys-for-an-account-get-the-payload-logging-key Read
Set the payload logging key — cloudflare.payload-logging-keys-for-an-account-set-the-payload-logging-key Write
List apps — cloudflare.flagship_list_apps Read
Create app — cloudflare.flagship_create_app Write
Delete app — cloudflare.flagship_delete_app Write
Get app — cloudflare.flagship_get_app Read
Update app — cloudflare.flagship_update_app Write
Get flag definitions — cloudflare.flagship_get_definitions Read
Evaluate flag from query context — cloudflare.flagship_evaluate_flag Read
Evaluate flag with JSON context — cloudflare.flagship_evaluate_flag_post Write
List flags — cloudflare.flagship_list_flags Read
Create flag — cloudflare.flagship_create_flag Write
Delete flag — cloudflare.flagship_delete_flag Write
Get flag — cloudflare.flagship_get_flag Read
Partially update flag — cloudflare.flagship_patch_flag Write
Update flag — cloudflare.flagship_update_flag Write
List flag changelog entries — cloudflare.flagship_get_flag_changelog Read
Get Zero Trust account information — cloudflare.zero-trust-accounts-get-zero-trust-account-information Read
Create Zero Trust account — cloudflare.zero-trust-accounts-create-zero-trust-account Write
List application and application type mappings — cloudflare.zero-trust-gateway-application-and-application-type-mappin-ae71b8b2fb Read
List applications review statuses — cloudflare.zero-trust-applications-review-status-list Read
Update applications review statuses — cloudflare.zero-trust-applications-review-status-update Write
Get Zero Trust SSH settings — cloudflare.zero-trust-get-audit-ssh-settings Read
Update Zero Trust SSH settings — cloudflare.zero-trust-update-audit-ssh-settings Write
Rotate Zero Trust SSH account seed — cloudflare.zero-trust-rotate-ssh-account-seed Write
List categories — cloudflare.zero-trust-gateway-categories-list-categories Read
List Zero Trust certificates — cloudflare.zero-trust-certificates-list-zero-trust-certificates Read
Create Zero Trust certificate — cloudflare.zero-trust-certificates-create-zero-trust-certificate Write
Delete Zero Trust certificate — cloudflare.zero-trust-certificates-delete-zero-trust-certificate Write
Get Zero Trust certificate details — cloudflare.zero-trust-certificates-zero-trust-certificate-details Read
Activate a Zero Trust certificate — cloudflare.zero-trust-certificates-activate-zero-trust-certificate Write
Deactivate a Zero Trust certificate — cloudflare.zero-trust-certificates-deactivate-zero-trust-certificate Write
Get Zero Trust account configuration — cloudflare.zero-trust-accounts-get-zero-trust-account-configuration Read
Patch Zero Trust account configuration — cloudflare.zero-trust-accounts-patch-zero-trust-account-configuration Write
Update Zero Trust account configuration — cloudflare.zero-trust-accounts-update-zero-trust-account-configuration. Write
List Zero Trust Gateway DNS destination IPv4 address pairs — cloudflare.zero-trust-dns-destination-ips-list-dns-destination-ips Read
Get gateway egress CIDRs pairs assigned to this account — cloudflare.zero-trust-accounts-get-egress-cidr-pairs Read
List Zero Trust lists — cloudflare.zero-trust-lists-list-zero-trust-lists Read
Create Zero Trust list — cloudflare.zero-trust-lists-create-zero-trust-list Write
Delete Zero Trust list — cloudflare.zero-trust-lists-delete-zero-trust-list Write
Get Zero Trust list details — cloudflare.zero-trust-lists-zero-trust-list-details Read
Patch Zero Trust list. — cloudflare.zero-trust-lists-patch-zero-trust-list Write
Update Zero Trust list — cloudflare.zero-trust-lists-update-zero-trust-list Write
Get Zero Trust list items — cloudflare.zero-trust-lists-zero-trust-list-items Read
List Zero Trust Gateway locations — cloudflare.zero-trust-gateway-locations-list-zero-trust-gateway-locations Read
Create a Zero Trust Gateway location — cloudflare.zero-trust-gateway-locations-create-zero-trust-gateway-location Write
Delete a Zero Trust Gateway location — cloudflare.zero-trust-gateway-locations-delete-zero-trust-gateway-location Write
Get Zero Trust Gateway location details — cloudflare.zero-trust-gateway-locations-zero-trust-gateway-location-details Read
Update a Zero Trust Gateway location — cloudflare.zero-trust-gateway-locations-update-zero-trust-gateway-location Write
Get logging settings for the Zero Trust account — cloudflare.zero-trust-accounts-get-logging-settings-for-the-zero-trust-account Read
Update Zero Trust account logging settings — cloudflare.zero-trust-accounts-update-logging-settings-for-the-zero-t-bc8951dcc5 Write
List Zero Trust Gateway operations — cloudflare.zero-trust-gateway-operations-list-zero-trust-gateway-operations Read
Zero Trust Gateway operation details — cloudflare.zero-trust-gateway-operations-zero-trust-gateway-operation-details Read
List PAC files — cloudflare.zero-trust-gateway-pacfiles-list Read
Create a PAC file — cloudflare.zero-trust-gateway-pacfiles-create-pacfile Write
Delete a PAC file — cloudflare.zero-trust-gateway-pacfiles-delete Write
Get a PAC file — cloudflare.zero-trust-gateway-pacfiles-details Read
Update a Zero Trust Gateway PAC file — cloudflare.zero-trust-gateway-pacfiles-update Write
List proxy endpoints — cloudflare.zero-trust-gateway-proxy-endpoints-list-proxy-endpoints Read
Create a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-create-proxy-endpoint Write
Delete a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint Write
Get a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-proxy-endpoint-details Read
Update a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-update-proxy-endpoint Write
List Zero Trust Gateway rules — cloudflare.zero-trust-gateway-rules-list-zero-trust-gateway-rules Read
Patch multiple Zero Trust Gateway rules — cloudflare.zero-trust-gateway-rules-patch-multiple-zero-trust-gateway-rules Write
Create a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-create-zero-trust-gateway-rule Write
List Zero Trust Gateway rules inherited from the parent account — cloudflare.zero-trust-gateway-rules-list-zero-trust-gateway-rules-tenant Read
Delete a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-delete-zero-trust-gateway-rule Write
Get Zero Trust Gateway rule details. — cloudflare.zero-trust-gateway-rules-zero-trust-gateway-rule-details Read
Patch a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-patch-zero-trust-gateway-rule Write
Update a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-update-zero-trust-gateway-rule Write
Reset the expiration of a Zero Trust Gateway Rule — cloudflare.zero-trust-gateway-rules-reset-expiration-zero-trust-gateway-rule Write
List Hyperdrives — cloudflare.list-hyperdrive Read
Create Hyperdrive — cloudflare.create-hyperdrive Write
Delete Hyperdrive — cloudflare.delete-hyperdrive Write
Get Hyperdrive — cloudflare.get-hyperdrive Read
Update Hyperdrive — cloudflare.patch-hyperdrive Write
Replace Hyperdrive — cloudflare.update-hyperdrive Write
Restart Hyperdrive — cloudflare.restart-hyperdrive Write
Create Database Signature — cloudflare.create-hyperdrive-database-signature Write
List Account Permission Groups — cloudflare.account-permission-group-list Read
Permission Group Details — cloudflare.account-permission-group-details Read
List Resource Groups — cloudflare.account-resource-group-list Read
Create Resource Group — cloudflare.account-resource-group-create Write
Remove Resource Group — cloudflare.account-resource-group-delete Write
Resource Group Details — cloudflare.account-resource-group-details Read
Update Resource Group — cloudflare.account-resource-group-update Write
List User Groups — cloudflare.account-user-group-list Read
Create User Group — cloudflare.account-user-group-create Write
Remove User Group — cloudflare.account-user-group-delete Write
User Group Details — cloudflare.account-user-group-details Read
Update User Group — cloudflare.account-user-group-update Write
List User Group Members — cloudflare.account-user-group-member-list Read
Add User Group Members — cloudflare.account-user-group-member-create Write
Update User Group Members — cloudflare.account-user-group-members-update Write
Remove User Group Member — cloudflare.account-user-group-member-delete Write
Get User Group Member — cloudflare.account-user-group-member-get Read
List Signing Keys — cloudflare.cloudflare-images-keys-list-signing-keys Read
Delete Signing Key — cloudflare.cloudflare-images-keys-delete-signing-key Write
Create a new Signing Key — cloudflare.cloudflare-images-keys-add-signing-key Write
Images usage statistics — cloudflare.cloudflare-images-images-usage-statistics Read
List variants — cloudflare.cloudflare-images-variants-list-variants Read
Create a variant — cloudflare.cloudflare-images-variants-create-a-variant Write
Delete a variant — cloudflare.cloudflare-images-variants-delete-a-variant Write
Variant details — cloudflare.cloudflare-images-variants-variant-details Read
Update a variant — cloudflare.cloudflare-images-variants-update-a-variant Write
List images V2 — cloudflare.cloudflare-images-list-images-v2 Read
List image metadata keys — cloudflare.cloudflare-images-list-metadata-keys Read
List sourcing kit migrations — cloudflare.cloudflare-images-sourcingkit-list-migrations Read
Create a sourcing kit migration — cloudflare.cloudflare-images-sourcingkit-create-migration Write
Delete a sourcing kit migration — cloudflare.cloudflare-images-sourcingkit-delete-migration Write
Get sourcing kit migration — cloudflare.cloudflare-images-sourcingkit-get-migration Read
Get migration progress — cloudflare.cloudflare-images-sourcingkit-get-migration-progress Read
Abort a migration — cloudflare.cloudflare-images-sourcingkit-abort-migration Write
Start a migration — cloudflare.cloudflare-images-sourcingkit-start-migration Write
List migration logs — cloudflare.cloudflare-images-sourcingkit-list-migration-logs Read
List sourcing kit sources — cloudflare.cloudflare-images-sourcingkit-list-sources Read
Create a sourcing kit source — cloudflare.cloudflare-images-sourcingkit-create-source Write
Precheck source connectivity — cloudflare.cloudflare-images-sourcingkit-precheck-source-connectivity Write
Delete a sourcing kit source — cloudflare.cloudflare-images-sourcingkit-delete-source Write
Get sourcing kit source — cloudflare.cloudflare-images-sourcingkit-get-source Read
Update a sourcing kit source — cloudflare.cloudflare-images-sourcingkit-update-source Write
Get source connectivity status — cloudflare.cloudflare-images-sourcingkit-get-source-connectivity Read
List all targets — cloudflare.infra-targets-list Read
Create new target — cloudflare.infra-targets-post Write
Create new targets — cloudflare.infra-targets-put-batch Write
Delete targets — cloudflare.infra-targets-delete-batch-post Write
Replace tags on existing targets — cloudflare.infra-targets-post-batch-tags Write
Delete target — cloudflare.infra-targets-delete Write
Get target — cloudflare.infra-targets-get Read
Update target — cloudflare.infra-targets-put Write
Get ASN Overview. — cloudflare.asn-intelligence-get-asn-overview Read
Get ASN Subnets — cloudflare.asn-intelligence-get-asn-subnets Read
Retrieves Security Center Issues Types — cloudflare.get-security-center-issue-types Read
Get Passive DNS by IP — cloudflare.passive-dns-by-ip-get-passive-dns-by-ip Read
Get Domain Details — cloudflare.domain-intelligence-get-domain-details Read
Get Domain History — cloudflare.domain-history-get-domain-history Read
Get Multiple Domain Details — cloudflare.domain-intelligence-get-multiple-domain-details Read
Get indicator feeds owned by this account — cloudflare.custom-indicator-feeds-get-indicator-feeds Read
Create new indicator feed — cloudflare.custom-indicator-feeds-create-indicator-feeds Write
Grant permission to indicator feed — cloudflare.custom-indicator-feeds-add-permission Write
Create indicator feed provider — cloudflare.custom-indicator-feeds-create-provider Write
Revoke permission to indicator feed — cloudflare.custom-indicator-feeds-remove-permission Write
List indicator feed permissions — cloudflare.custom-indicator-feeds-view-permissions Read
Get indicator feed metadata — cloudflare.custom-indicator-feeds-get-indicator-feed-metadata Read
Update indicator feed metadata — cloudflare.custom-indicator-feeds-update-indicator-feed-metadata Write
Get indicator feed data — cloudflare.custom-indicator-feeds-get-indicator-feed-data Read
Download indicator feed data — cloudflare.custom-indicator-feeds-download-indicator-feed-data Read
Get indicator feed upload status — cloudflare.custom-indicator-feeds-get-upload-status Read
Get IP Overview — cloudflare.ip-intelligence-get-ip-overview Read
Get Available IP Lists — cloudflare.ip-list-get-ip-lists Read
Create Miscategorization — cloudflare.miscategorization-create-miscategorization Write
List sinkholes owned by this account — cloudflare.sinkhole-config-list-sinkholes Read
Create a new sinkhole for your account — cloudflare.sinkhole-config-create-sinkhole Write
Delete a sinkhole — cloudflare.sinkhole-config-delete-sinkhole Write
Get a sinkhole — cloudflare.sinkhole-config-get-sinkhole Read
Update a sinkhole — cloudflare.sinkhole-config-update-sinkhole Write
List ingresses for a sinkhole — cloudflare.sinkhole-config-list-sinkhole-ingresses Read
Get URL Intelligence — cloudflare.url-intelligence-get-url-intelligence Read
Get WHOIS Record — cloudflare.whois-record-get-whois-record Read
Toggle PDF Invoices — cloudflare.account-billing-toggle-pdf-invoices Write
List K2 streams — cloudflare.getv4accountsbyaccount_idk2streams Read
Create K2 stream — cloudflare.postv4accountsbyaccount_idk2streams Write
Delete K2 stream — cloudflare.deletev4accountsbyaccount_idk2streamsbystream_id Write
Get K2 stream — cloudflare.getv4accountsbyaccount_idk2streamsbystream_id Read
List subscriptions with consumer lag — cloudflare.getv4accountsbyaccount_idk2streamsbystream_idsubscriptions Read
List Account Load Balancers — cloudflare.account-load-balancers-list-account-load-balancers Read
List Monitor Groups — cloudflare.account-load-balancer-monitor-groups-list-monitor-groups Read
Create Monitor Group — cloudflare.account-load-balancer-monitor-groups-create-monitor-group Write
Delete Monitor Group — cloudflare.account-load-balancer-monitor-groups-delete-monitor-group Write
Monitor Group Details — cloudflare.account-load-balancer-monitor-groups-monitor-group-details Read
Patch Monitor Group — cloudflare.account-load-balancer-monitor-groups-patch-monitor-group Write
Update Monitor Group — cloudflare.account-load-balancer-monitor-groups-update-monitor-group Write
List Monitor Group References — cloudflare.account-load-balancer-monitor-groups-list-monitor-group-references Read
List Monitors — cloudflare.account-load-balancer-monitors-list-monitors Read
Create Monitor — cloudflare.account-load-balancer-monitors-create-monitor Write
Delete Monitor — cloudflare.account-load-balancer-monitors-delete-monitor Write
Monitor Details — cloudflare.account-load-balancer-monitors-monitor-details Read
Patch Monitor — cloudflare.account-load-balancer-monitors-patch-monitor Write
Update Monitor — cloudflare.account-load-balancer-monitors-update-monitor Write
Preview Monitor — cloudflare.account-load-balancer-monitors-preview-monitor Write
List Monitor References — cloudflare.account-load-balancer-monitors-list-monitor-references Read
List Pools — cloudflare.account-load-balancer-pools-list-pools Read
Patch Pools — cloudflare.account-load-balancer-pools-patch-pools Write
Create Pool — cloudflare.account-load-balancer-pools-create-pool Write
Delete Pool — cloudflare.account-load-balancer-pools-delete-pool Write
Pool Details — cloudflare.account-load-balancer-pools-pool-details Read
Patch Pool — cloudflare.account-load-balancer-pools-patch-pool Write
Update Pool — cloudflare.account-load-balancer-pools-update-pool Write
Pool Health Details — cloudflare.account-load-balancer-pools-pool-health-details Read
Preview Pool — cloudflare.account-load-balancer-pools-preview-pool Write
List Pool References — cloudflare.account-load-balancer-pools-list-pool-references Read
Preview Result — cloudflare.account-load-balancer-monitors-preview-result Read
List Regions — cloudflare.load-balancer-regions-list-regions Read
Get Region — cloudflare.load-balancer-regions-get-region Read
Search Resources — cloudflare.account-load-balancer-search-search-resources Read
List Load Balancer Usage — cloudflare.account-load-balancers-list-load-balancer-usage Read
Delete Account Load Balancer — cloudflare.account-load-balancers-delete-account-load-balancer Write
Account Load Balancer Details — cloudflare.account-load-balancers-account-load-balancer-details Read
Patch Account Load Balancer — cloudflare.account-load-balancers-patch-account-load-balancer Write
List fields — cloudflare.get-accounts-account_id-logpush-datasets-dataset_id-fields Read
List Logpush jobs for a dataset — cloudflare.get-accounts-account_id-logpush-datasets-dataset_id-jobs Read
List Logpush jobs — cloudflare.get-accounts-account_id-logpush-jobs Read
Create Logpush job — cloudflare.post-accounts-account_id-logpush-jobs Write
Delete Logpush job — cloudflare.delete-accounts-account_id-logpush-jobs-job_id Write
Get Logpush job details — cloudflare.get-accounts-account_id-logpush-jobs-job_id Read
Update Logpush job — cloudflare.put-accounts-account_id-logpush-jobs-job_id Write
Get ownership challenge — cloudflare.post-accounts-account_id-logpush-ownership Write
Validate ownership challenge — cloudflare.post-accounts-account_id-logpush-ownership-validate Write
List transformers — cloudflare.get-accounts-account_id-logpush-transformers Read
Create transformer — cloudflare.post-accounts-account_id-logpush-transformers Write
Preview transformer — cloudflare.post-accounts-account_id-logpush-transformers-preview Write
Delete transformer — cloudflare.delete-accounts-account_id-logpush-transformers-transformer_id Write
Get transformer — cloudflare.get-accounts-account_id-logpush-transformers-transformer_id Read
Update transformer — cloudflare.put-accounts-account_id-logpush-transformers-transformer_id Write
Get transformer content — cloudflare.get-accounts-account_id-logpush-transformers-transformer_id-content Read
List transformer versions — cloudflare.get-accounts-account_id-logpush-transformers-transformer_id-versions Read
Validate destination — cloudflare.delete-accounts-account_id-logpush-validate-destination Write
Check destination exists — cloudflare.delete-accounts-account_id-logpush-validate-destination-exists Write
Validate origin — cloudflare.post-accounts-account_id-logpush-validate-origin Write
Get account audit logs (Version 2) — cloudflare.audit-logs-v2-get-account-audit-logs Read
List account audit log product categories (Version 2) — cloudflare.audit-logs-v2-list-account-product-categories Read
Get resource change history from an account audit log entry (Version 2) — cloudflare.audit-logs-v2-get-account-audit-log-history Read
Delete CMB config — cloudflare.delete-accounts-account_id-logs-control-cmb-config Write
Get CMB config — cloudflare.get-accounts-account_id-logs-control-cmb-config Read
Update CMB config — cloudflare.post-accounts-account_id-logs-control-cmb-config Write
Delete all DNS Protection rules. — cloudflare.deletednsprotectionrulesforaccount Write
List all DNS Protection rules. — cloudflare.listdnsprotectionrulesforaccount Read
Create DNS Protection rule. — cloudflare.creatednsprotectionrule Write
Delete DNS Protection rule. — cloudflare.deletednsprotectionrule Write
Get DNS Protection rule. — cloudflare.getdnsprotectionrule Read
Update DNS Protection rule. — cloudflare.updatednsprotectionrule Write
Delete all allowlist prefixes. — cloudflare.deleteallowlistprefixesforaccount Write
List all allowlist prefixes. — cloudflare.listallowlistprefixesforaccount Read
Create allowlist prefix. — cloudflare.createallowlistedprefix Write
Delete allowlist prefix. — cloudflare.deleteallowlistprefix Write
Get allowlist prefix. — cloudflare.getallowlistprefix Read
Update allowlist prefix. — cloudflare.updateallowlistprefix Write
Delete all prefixes. — cloudflare.deleteprefixesforaccount Write
List all prefixes. — cloudflare.listprefixesforaccount Read
Create prefix. — cloudflare.createprefix Write
Create multiple prefixes. — cloudflare.bulkcreateprefixes Write
Delete prefix. — cloudflare.deleteprefix Write
Get prefix. — cloudflare.getprefix Read
Update prefix. — cloudflare.updateprefix Write
Delete all SYN Protection filters. — cloudflare.deletesynprotectionfiltersforaccount Write
List all SYN Protection filters. — cloudflare.listsynprotectionfiltersforaccount Read
Create a SYN Protection filter. — cloudflare.createsynprotectionfilter Write
Delete SYN Protection filter. — cloudflare.deletesynprotectionfilter Write
Get SYN Protection filter. — cloudflare.getsynprotectionfilter Read
Update SYN Protection filter. — cloudflare.updatesynprotectionfilter Write
Delete all SYN Protection rules. — cloudflare.deletesynprotectionrulesforaccount Write
List all SYN Protection rules. — cloudflare.listsynprotectionrulesforaccount Read
Create SYN Protection rule. — cloudflare.createsynprotectionrule Write
Delete SYN Protection rule. — cloudflare.deletesynprotectionrule Write
Get SYN Protection rule. — cloudflare.getsynprotectionrule Read
Update SYN Protection rule. — cloudflare.updatesynprotectionrule Write
Delete all TCP Flow Protection filters. — cloudflare.deletetcpflowprotectionfiltersforaccount Write
List all TCP Flow Protection filters. — cloudflare.listtcpflowprotectionfiltersforaccount Read
Create a TCP Flow Protection filter. — cloudflare.createtcpflowprotectionfilter Write
Delete TCP Flow Protection filter. — cloudflare.deletetcpflowprotectionfilter Write
Get TCP Flow Protection filter. — cloudflare.gettcpflowprotectionfilter Read
Update TCP Flow Protection filter. — cloudflare.updatetcpflowprotectionfilter Write
Delete all TCP Flow Protection rules. — cloudflare.deletetcpflowprotectionrulesforaccount Write
List all TCP Flow Protection rules. — cloudflare.listtcpflowprotectionrulesforaccount Read
Create TCP Flow Protection rule. — cloudflare.createtcpflowprotectionrule Write
Delete TCP Flow Protection rule. — cloudflare.deletetcpflowprotectionrule Write
Get TCP Flow Protection rule. — cloudflare.gettcpflowprotectionrule Read
Update TCP Flow Protection rule. — cloudflare.updatetcpflowprotectionrule Write
Get protection status. — cloudflare.getprotectionstatus Read
Update protection status. — cloudflare.updateprotectionstatus Write
List Apps — cloudflare.magic-account-apps-list-apps Read
Create a new App — cloudflare.magic-account-apps-add-app Write
Delete Account App — cloudflare.magic-account-apps-delete-app Write
Update an App — cloudflare.magic-account-apps-patch-app Write
Update an App — cloudflare.magic-account-apps-update-app Write
List BGP Filter Profiles — cloudflare.magic-bgp-list-filter-profiles Read
Create BGP Filter Profile — cloudflare.magic-bgp-create-filter-profile Write
Delete BGP Filter Profile — cloudflare.magic-bgp-delete-filter-profile Write
Get BGP Filter Profile — cloudflare.magic-bgp-get-filter-profile Read
Get BGP Settings — cloudflare.magic-bgp-get-settings Read
Update BGP Settings — cloudflare.magic-bgp-update-settings Write
List CF1 Sites — cloudflare.magic-cf1-sites-list-cf1-sites Read
Create CF1 Sites — cloudflare.magic-cf1-sites-create-cf1-sites Write
Delete CF1 Site — cloudflare.magic-cf1-sites-delete-cf1-site Write
Get CF1 Site — cloudflare.magic-cf1-sites-get-cf1-site Read
Update CF1 Site — cloudflare.magic-cf1-sites-update-cf1-site Write
List CF1 Site Ramps — cloudflare.magic-cf1-sites-list-cf1-site-ramps Read
Create CF1 Site Ramps — cloudflare.magic-cf1-sites-create-cf1-site-ramps Write
Delete CF1 Site Ramp — cloudflare.magic-cf1-sites-delete-cf1-site-ramp Write
Get CF1 Site Ramp — cloudflare.magic-cf1-sites-get-cf1-site-ramp Read
List interconnects — cloudflare.magic-interconnects-list-interconnects Read
Update multiple interconnects — cloudflare.magic-interconnects-update-multiple-interconnects Write
List interconnect Details — cloudflare.magic-interconnects-list-interconnect-details Read
Update interconnect — cloudflare.magic-interconnects-update-interconnect Write
List Connectors — cloudflare.mconn-connectors-list Read
Delete Connector — cloudflare.mconn-connectors-delete Write
Get Connector — cloudflare.mconn-connectors-get Read
Edit Connector — cloudflare.mconn-connectors-edit Write
Update Connector — cloudflare.mconn-connectors-update Write
List Interrupts — cloudflare.mconn-connector-interrupts-list Read
List Events — cloudflare.mconn-connector-telemetry-events-list Read
Get latest Events — cloudflare.mconn-connector-telemetry-events-latest-get Read
Get Event — cloudflare.mconn-connector-telemetry-events-get Read
List Snapshots — cloudflare.mconn-connector-telemetry-snapshots-list Read
Get latest Snapshots — cloudflare.mconn-connector-telemetry-snapshots-latest-get Read
Get Snapshot — cloudflare.mconn-connector-telemetry-snapshots-get Read
List GRE tunnels — cloudflare.magic-gre-tunnels-list-gre-tunnels Read
Create a GRE tunnel — cloudflare.magic-gre-tunnels-create-gre-tunnels Write
Update multiple GRE tunnels — cloudflare.magic-gre-tunnels-update-multiple-gre-tunnels Write
Delete GRE Tunnel — cloudflare.magic-gre-tunnels-delete-gre-tunnel Write
List GRE Tunnel Details — cloudflare.magic-gre-tunnels-list-gre-tunnel-details Read
Update GRE Tunnel — cloudflare.magic-gre-tunnels-update-gre-tunnel Write
List IPsec tunnels — cloudflare.magic-ipsec-tunnels-list-ipsec-tunnels Read
Create an IPsec tunnel — cloudflare.magic-ipsec-tunnels-create-ipsec-tunnels Write
Update multiple IPsec tunnels — cloudflare.magic-ipsec-tunnels-update-multiple-ipsec-tunnels Write
Set Pre-Shared Keys (PSK) for IPsec tunnels — cloudflare.magic-ipsec-tunnels-set-pre-shared-keys-for-ipsec-tunnels Write
Delete IPsec Tunnel — cloudflare.magic-ipsec-tunnels-delete-ipsec-tunnel Write
List IPsec tunnel details — cloudflare.magic-ipsec-tunnels-list-ipsec-tunnel-details Read
Update IPsec Tunnel — cloudflare.magic-ipsec-tunnels-update-ipsec-tunnel Write
Generate Pre-Shared Key (PSK) for IPsec tunnels — cloudflare.magic-ipsec-tunnels-generate-pre-shared-key---psk--for-ipsec-tunnels Write
List Redundancy Groups — cloudflare.magic-redundancy-groups-list-redundancy-groups Read
Create a Redundancy Group — cloudflare.magic-redundancy-groups-create-redundancy-group Write
Delete a Redundancy Group — cloudflare.magic-redundancy-groups-delete-redundancy-group Write
Get Redundancy Group Details — cloudflare.magic-redundancy-groups-get-redundancy-group Read
Update a Redundancy Group — cloudflare.magic-redundancy-groups-update-redundancy-group Write
Delete Many Routes — cloudflare.magic-static-routes-delete-many-routes Write
List Routes — cloudflare.magic-static-routes-list-routes Read
Create a Route — cloudflare.magic-static-routes-create-routes Write
Update Many Routes — cloudflare.magic-static-routes-update-many-routes Write
Delete Route — cloudflare.magic-static-routes-delete-route Write
Route Details — cloudflare.magic-static-routes-route-details Read
Update Route — cloudflare.magic-static-routes-update-route Write
List Sites — cloudflare.magic-sites-list-sites Read
Create a new Site — cloudflare.magic-sites-create-site Write
Delete Site — cloudflare.magic-sites-delete-site Write
Site Details — cloudflare.magic-sites-site-details Read
Patch Site — cloudflare.magic-sites-patch-site Write
Update Site — cloudflare.magic-sites-update-site Write
List Site ACLs — cloudflare.magic-site-acls-list-acls Read
Create a new Site ACL — cloudflare.magic-site-acls-create-acl Write
Delete Site ACL — cloudflare.magic-site-acls-delete-acl Write
Site ACL Details — cloudflare.magic-site-acls-acl-details Read
Patch Site ACL — cloudflare.magic-site-acls-patch-acl Write
Update Site ACL — cloudflare.magic-site-acls-update-acl Write
List App Configs — cloudflare.magic-site-app-configs-list-app-configs Read
Delete App Config — cloudflare.magic-site-app-configs-delete-app-config Write
Update an App Config — cloudflare.magic-site-app-configs-patch-app-config Write
Update an App Config — cloudflare.magic-site-app-configs-update-app-config Write
List Site LANs — cloudflare.magic-site-lans-list-lans Read
Create a new Site LAN — cloudflare.magic-site-lans-create-lan Write
Delete Site LAN — cloudflare.magic-site-lans-delete-lan Write
Site LAN Details — cloudflare.magic-site-lans-lan-details Read
Patch Site LAN — cloudflare.magic-site-lans-patch-lan Write
Update Site LAN — cloudflare.magic-site-lans-update-lan Write
Delete NetFlow Configuration — cloudflare.magic-site-netflow-config-delete-netflow-config Write
NetFlow Configuration Details — cloudflare.magic-site-netflow-config-details Read
Update NetFlow Configuration — cloudflare.magic-site-netflow-config-patch-netflow-config Write
Create NetFlow Configuration — cloudflare.magic-site-netflow-config-create-netflow-config Write
Update NetFlow Configuration — cloudflare.magic-site-netflow-config-update-netflow-config Write
List Site WANs — cloudflare.magic-site-wans-list-wans Read
Create a new Site WAN — cloudflare.magic-site-wans-create-wan Write
Delete Site WAN — cloudflare.magic-site-wans-delete-wan Write
Site WAN Details — cloudflare.magic-site-wans-wan-details Read
Patch Site WAN — cloudflare.magic-site-wans-patch-wan Write
Update Site WAN — cloudflare.magic-site-wans-update-wan Write
List repositories — cloudflare.listaccountvulnerabilitydiscoveryrepositories Read
Create repository — cloudflare.createaccountvulnerabilitydiscoveryrepository Write
Get repository — cloudflare.getaccountvulnerabilitydiscoveryrepository Read
Get reviewed vulnerability report — cloudflare.getaccountrepositoryvulnerabilitydiscoveryreport Read
Create upload token — cloudflare.createaccountvulnerabilitydiscoveryrepositorytoken Write
List scans — cloudflare.listaccountvulnerabilitydiscoveryscans Read
Create scan — cloudflare.createaccountvulnerabilitydiscoveryscan Write
Get scan — cloudflare.getaccountvulnerabilitydiscoveryscan Read
Get reviewed vulnerability report — cloudflare.getaccountvulnerabilitydiscoveryconsolidatedreport Read
Get account Media usage — cloudflare.usage-analytics-get-account-media-usage Read
List Members — cloudflare.account-members-list-members Read
Add Member — cloudflare.account-members-add-member Write
Remove Member — cloudflare.account-members-remove-member Write
Member Details — cloudflare.account-members-member-details Read
Update Member — cloudflare.account-members-update-member Write
Delete account configuration — cloudflare.magic-network-monitoring-configuration-delete-account-configuration Write
List account configuration — cloudflare.magic-network-monitoring-configuration-list-account-configuration Read
Update account configuration fields — cloudflare.magic-network-monitoring-configuration-update-account-conf-75bc5c098c Write
Create account configuration — cloudflare.magic-network-monitoring-configuration-create-account-configuration Write
Update an entire account configuration — cloudflare.magic-network-monitoring-configuration-update-an-entire-ac-313c46ca16 Write
List rules and account configuration — cloudflare.magic-network-monitoring-configuration-list-rules-and-acco-ed4cfee0df Read
List rules — cloudflare.magic-network-monitoring-rules-list-rules Read
Delete rule — cloudflare.magic-network-monitoring-rules-delete-rule Write
Get rule — cloudflare.magic-network-monitoring-rules-get-rule Read
Update advertisement for rule — cloudflare.magic-network-monitoring-rules-update-advertisement-for-rule Write
Generate authentication token for VPC flow logs export. — cloudflare.magic-network-monitoring-vpc-flows-generate-authentication-token Write
Get account monetization eligibility — cloudflare.monetization-get-account-eligibility Read
Check account monetization eligibility — cloudflare.monetization-check-account-eligibility Write
List relays — cloudflare.moq-relays-list Read
Create a relay — cloudflare.moq-relays-create Write
Delete a relay — cloudflare.moq-relays-delete Write
Get a relay — cloudflare.moq-relays-get Read
Update a relay — cloudflare.moq-relays-update Write
List tokens — cloudflare.moq-relays-tokens-list Read
Create a token — cloudflare.moq-relays-tokens-create Write
Revoke a token — cloudflare.moq-relays-tokens-delete Write
Move account to organization — cloudflare.accounts_moveaccounts Write
List mTLS certificates — cloudflare.m-tls-certificate-management-list-m-tls-certificates Read
Upload mTLS certificate — cloudflare.m-tls-certificate-management-upload-m-tls-certificate Write
Delete mTLS certificate — cloudflare.m-tls-certificate-management-delete-m-tls-certificate Write
Get mTLS certificate — cloudflare.m-tls-certificate-management-get-m-tls-certificate Read
List mTLS certificate associations — cloudflare.m-tls-certificate-management-list-m-tls-certificate-associations Read
List OAuth Clients — cloudflare.oauth-clients-list Read
Delete OAuth Client — cloudflare.oauth-clients-delete Write
OAuth Client Details — cloudflare.oauth-clients-get Read
Update OAuth Client — cloudflare.oauth-clients-update Write
Delete Rotated OAuth Client Secret — cloudflare.oauth-clients-delete-rotated-secret Write
Rotate OAuth Client Secret — cloudflare.oauth-clients-rotate-secret Write
Get usage limit status — cloudflare.observability.usage_limit.get Read
List applications — cloudflare.list_applications_v2 Read
Get application details — cloudflare.get_application_v2 Read
Get auth methods — cloudflare.get_application_auth_methods_v2 Read
Get application setup flows — cloudflare.get_application_setup_flows_v2 Read
List integrations — cloudflare.list_integrations_v2 Read
Create integration — cloudflare.create_integration_v2 Write
Delete integration — cloudflare.delete_integration_v2 Write
Get integration details — cloudflare.get_integration_v2 Read
Update integration — cloudflare.update_integration_v2 Write
Pause integration — cloudflare.pause_integration_v2 Write
Resume integration — cloudflare.resume_integration_v2 Write
List account organizations — cloudflare.accounts_listaccountorganizations Read
List Cloudflare Pages projects — cloudflare.pages-project-get-projects Read
Create a Cloudflare Pages project — cloudflare.pages-project-create-project Write
Delete a Cloudflare Pages project — cloudflare.pages-project-delete-project Write
Get a Cloudflare Pages project — cloudflare.pages-project-get-project Read
List Pages deployments — cloudflare.pages-deployment-get-deployments Read
Delete a Pages deployment — cloudflare.pages-deployment-delete-deployment Write
Get a Pages deployment — cloudflare.pages-deployment-get-deployment-info Read
Get Pages deployment logs — cloudflare.pages-deployment-get-deployment-logs Read
Retry a Pages deployment — cloudflare.pages-deployment-retry-deployment Write
Roll back a Pages deployment — cloudflare.pages-deployment-rollback-deployment Write
Create deployment tail — cloudflare.pages-deployment-create-tail Write
Delete deployment tail — cloudflare.pages-deployment-delete-tail Write
List Pages custom domains — cloudflare.pages-domains-get-domains Read
Add a Pages custom domain — cloudflare.pages-domains-add-domain Write
Delete a Pages custom domain — cloudflare.pages-domains-delete-domain Write
Get a Pages custom domain — cloudflare.pages-domains-get-domain Read
Retry custom domain validation — cloudflare.pages-domains-patch-domain Write
Purge the Pages build cache — cloudflare.pages-purge-build-cache Write
Disconnect a Git repository — cloudflare.pages-project-disconnect-project-source Write
Connect a Git repository — cloudflare.pages-project-connect-project-source Write
Get upload token — cloudflare.pages-project-get-upload-token Read
Pay Invoice — cloudflare.account-billing-pay-invoice Write
Deletes the stripe config for a crawler — cloudflare.pay-per-crawl.crawlerdeletestripeconfig Write
Gets the stripe config for a crawler — cloudflare.pay-per-crawl.crawlergetstripeconfig Read
Creates the stripe config for a crawler — cloudflare.pay-per-crawl.crawlercreatestripeconfig Write
List pay-per-crawl crawlers — cloudflare.pay-per-crawl.listcrawlers Read
Deletes the stripe config for a publisher — cloudflare.pay-per-crawl.publisherdeletestripeconfig Write
Gets the stripe config for a publisher — cloudflare.pay-per-crawl.publishergetstripeconfig Read
Creates the stripe config for a publisher — cloudflare.pay-per-crawl.publishercreatestripeconfig Write
Get signed pay-per-crawl terms link — cloudflare.pay-per-crawl.gettermssignaturelink Read
Get pay-per-crawl terms — cloudflare.pay-per-crawl.getterms Read
Get pay-per-crawl terms signature status — cloudflare.pay-per-crawl.gettermssignature Read
Record pay-per-crawl terms activity — cloudflare.pay-per-crawl.sendtermssignatureevent Write
Set can_be_enabled setting on zones — cloudflare.pay-per-crawl.setzonescanbeenabled Write
Gets the can_be_enabled zone setting — cloudflare.pay-per-crawl.queryzonescanbeenabled Write
List enabled Pay Per Use domains — cloudflare.pay-per-use.listenableddomains Read
Get pay-per-use operator configuration — cloudflare.pay-per-crawl.getppuoperatorconfiguration Read
Set pay-per-use operator configuration — cloudflare.pay-per-crawl.putppuoperatorconfiguration Write
List pay-per-use price proposals — cloudflare.pay-per-crawl.listppuproposals Read
Decide a pay-per-use price proposal — cloudflare.pay-per-crawl.postppuproposaldecision Write
Get pay-per-use usage statistics — cloudflare.pay-per-crawl.getppuusagestats Read
Set pay-per-use zone eligibility — cloudflare.pay-per-crawl.setppuzonescanbeenabled Write
List Payment Methods — cloudflare.account-billing-list-payment-methods Read
Create Payment Method — cloudflare.account-billing-create-payment-method Write
Delete Payment Method — cloudflare.account-billing-delete-payment-method Write
Get Payment Method — cloudflare.account-billing-get-payment-method Read
Update Payment Method — cloudflare.account-billing-update-payment-method Write
Set Default Payment Method — cloudflare.account-billing-set-default-payment-method Write
List packet capture requests — cloudflare.magic-pcap-collection-list-packet-capture-requests Read
Create PCAP request — cloudflare.magic-pcap-collection-create-pcap-request Write
List PCAPs Bucket Ownership — cloudflare.magic-pcap-collection-list-pca-ps-bucket-ownership Read
Add buckets for full packet captures — cloudflare.magic-pcap-collection-add-buckets-for-full-packet-captures Write
Validate buckets for full packet captures — cloudflare.magic-pcap-collection-validate-buckets-for-full-packet-captures Write
Delete buckets for full packet captures — cloudflare.magic-pcap-collection-delete-buckets-for-full-packet-captures Write
Get PCAP request — cloudflare.magic-pcap-collection-get-pcap-request Read
Stop full PCAP — cloudflare.magic-pcap-collection-stop-full-pcap Write
List Pipelines — cloudflare.getv4accountsbyaccount_idpipelinesv1pipelines Read
Create Pipeline — cloudflare.postv4accountsbyaccount_idpipelinesv1pipelines Write
Delete Pipeline — cloudflare.deletev4accountsbyaccount_idpipelinesv1pipelinesbypipeline_id Write
Get Pipeline Details — cloudflare.getv4accountsbyaccount_idpipelinesv1pipelinesbypipeline_id Read
List Sinks — cloudflare.getv4accountsbyaccount_idpipelinesv1sinks Read
Create Sink — cloudflare.postv4accountsbyaccount_idpipelinesv1sinks Write
Delete Sink — cloudflare.deletev4accountsbyaccount_idpipelinesv1sinksbysink_id Write
Get Sink Details — cloudflare.getv4accountsbyaccount_idpipelinesv1sinksbysink_id Read
List Streams — cloudflare.getv4accountsbyaccount_idpipelinesv1streams Read
Create Stream — cloudflare.postv4accountsbyaccount_idpipelinesv1streams Write
Delete Stream — cloudflare.deletev4accountsbyaccount_idpipelinesv1streamsbystream_id Write
Get Stream Details — cloudflare.getv4accountsbyaccount_idpipelinesv1streamsbystream_id Read
Update Stream — cloudflare.patchv4accountsbyaccount_idpipelinesv1streamsbystream_id Write
Validate SQL — cloudflare.postv4accountsbyaccount_idpipelinesv1validate_sql Write
Get account profile — cloudflare.accounts_getaccountprofile Read
Update account profile — cloudflare.accounts_modifyaccountprofile Write
List Queues — cloudflare.queues-list Read
Create Queue — cloudflare.queues-create Write
Delete Queue — cloudflare.queues-delete Write
Get Queue — cloudflare.queues-get Read
Update Queue — cloudflare.queues-update-partial Write
Update Queue — cloudflare.queues-update Write
List Queue Consumers — cloudflare.queues-list-consumers Read
Create a Queue Consumer — cloudflare.queues-create-consumer Write
Delete Queue Consumer — cloudflare.queues-delete-consumer Write
Get Queue Consumer — cloudflare.queues-get-consumer Read
Update Queue Consumer — cloudflare.queues-update-consumer Write
Push Message — cloudflare.queues-push-message Write
Acknowledge + Retry Queue Messages — cloudflare.queues-ack-messages Write
Push Message Batch — cloudflare.queues-push-messages Write
Extend Message Leases — cloudflare.queues-extend-messages Write
Peek Queue Messages — cloudflare.queues-peek-messages Write
Pull Queue Messages — cloudflare.queues-pull-messages Write
Purge Peeked Queue Messages — cloudflare.queues-purge-messages Write
Get Queue Metrics — cloudflare.queues-get-metrics Read
Get Queue Purge Status — cloudflare.queues-purge-get Read
Purge Queue — cloudflare.queues-purge Write
List Buckets — cloudflare.r2-list-buckets Read
Delete Bucket — cloudflare.r2-delete-bucket Write
Get Bucket — cloudflare.r2-get-bucket Read
Patch Bucket — cloudflare.r2-patch-bucket Write
Create Bucket (by name) — cloudflare.r2-create-bucket-by-name Write
Delete Bucket CORS Policy — cloudflare.r2-delete-bucket-cors-policy Write
Get Bucket CORS Policy — cloudflare.r2-get-bucket-cors-policy Read
Set Bucket CORS Policy — cloudflare.r2-put-bucket-cors-policy Write
List Custom Domains of Bucket — cloudflare.r2-list-custom-domains Read
Attach Custom Domain To Bucket — cloudflare.r2-add-custom-domain Write
Remove Custom Domain From Bucket — cloudflare.r2-delete-custom-domain Write
Get Custom Domain Settings — cloudflare.r2-get-custom-domain-settings Read
Configure Custom Domain Settings — cloudflare.r2-edit-custom-domain-settings Write
Get r2.dev Domain of Bucket — cloudflare.r2-get-bucket-public-policy Read
Update r2.dev Domain of Bucket — cloudflare.r2-put-bucket-public-policy Write
List Bucket Jobs — cloudflare.r2-list-bucket-jobs Read
Create Bucket Job — cloudflare.r2-create-bucket-job Write
Get Bucket Job — cloudflare.r2-get-bucket-job Read
Get Object Lifecycle Rules — cloudflare.r2-get-bucket-lifecycle-configuration Read
Set Object Lifecycle Rules — cloudflare.r2-put-bucket-lifecycle-configuration Write
Get Local Uploads Configuration — cloudflare.r2-get-bucket-local-uploads-configuration Read
Set Local Uploads Configuration — cloudflare.r2-put-bucket-local-uploads-configuration Write
Delete Bucket Lock Rules — cloudflare.r2-delete-bucket-lock-configuration Write
Get Bucket Lock Rules — cloudflare.r2-get-bucket-lock-configuration Read
Set Bucket Lock Rules — cloudflare.r2-put-bucket-lock-configuration Write
Delete Objects — cloudflare.r2-delete-objects Write
List Objects — cloudflare.r2-list-objects Read
Delete Object — cloudflare.r2-delete-object Write
Disable Sippy — cloudflare.r2-delete-bucket-sippy-config Write
Get Sippy Configuration — cloudflare.r2-get-bucket-sippy-config Read
Get Account-Level Metrics — cloudflare.r2-get-account-level-metrics Read
Create Temporary Access Credentials — cloudflare.r2-create-temp-access-credentials Write
Fetch all apps — cloudflare.get_apps Read
Create App — cloudflare.create_app Write
Fetch app details — cloudflare.get_app Read
Update an app — cloudflare.update_app Write
Fetch day-wise session and recording analytics data for an App — cloudflare.get-org-analytics Read
Fetch day-wise analytics data for your livestreams — cloudflare.get-livestream-analytics-daywise Read
Fetch complete analytics data for your livestreams — cloudflare.get-livestream-analytics-complete Read
Fetch all livestreams — cloudflare.fetch_all_livestreams Read
Fetch livestream session details using livestream session ID — cloudflare.get-v2-livestreams-livestream-session-id Read
Fetch livestream details using livestream ID — cloudflare.get-v2-livestream-session-livestream-id Read
Fetch active livestream session details — cloudflare.get-v2-active-livestream-session-details Read
Fetch all meetings for an App — cloudflare.get_all_meetings Read
Create a meeting — cloudflare.create_meeting Write
Fetch a meeting for an App — cloudflare.get_meeting Read
Update a meeting — cloudflare.update_meeting Write
Replace a meeting — cloudflare.replace_meeting Write
Fetch active livestreams for a meeting — cloudflare.get-v2-meetings-meetingid-active-livestream Read
Stop livestreaming a meeting — cloudflare.stop_livestreaming Write
Fetch details of an active session — cloudflare.getactivesession Read
Kick participants from an active session — cloudflare.kickpartcipants Write
Kick all participants — cloudflare.kickallparticipants Write
Mute participants of an active session — cloudflare.muteparticipants Write
Mute all participants — cloudflare.muteallparticipants Write
Create a poll — cloudflare.createpoll Write
Fetch livestream session details for a meeting — cloudflare.livestream-session-details Read
Start livestreaming a meeting — cloudflare.start-livestreaming Write
Fetch all participants of a meeting — cloudflare.get_meeting_participants Read
Add a participant — cloudflare.add_participant Write
Delete a participant — cloudflare.delete_meeting_participant Write
Fetch a participant's detail — cloudflare.get_meeting_participant Read
Edit a participant's detail — cloudflare.edit_participant Write
Replace a participant's detail — cloudflare.replace_participant Write
Revoke participant's authentication token — cloudflare.revoke_token Write
Refresh participant's authentication token — cloudflare.regenerate_token Write
Fetch all presets — cloudflare.get-presets Read
Create a preset — cloudflare.post-presets Write
Delete a preset — cloudflare.delete-presets-preset_id Write
Fetch details of a preset — cloudflare.get-presets-preset_id Read
Update a preset — cloudflare.patch-presets-preset_id Write
Replace a preset — cloudflare.put-presets-preset_id Write
Fetch all recordings for an App — cloudflare.get_all_recordings Read
Start recording a meeting — cloudflare.start_recording Write
Fetch active recording — cloudflare.get_active_recording Read
Start recording participant audio tracks — cloudflare.starttrackrecordingforameeting Write
Fetch details of a recording — cloudflare.get_one_recording Read
Pause/Resume/Stop recording — cloudflare.pause_resume_stop_recording Write
Fetch all sessions of an App — cloudflare.getsessions Read
Fetch details of peer — cloudflare.getparticipantdatafrompeerid Read
Fetch details of a session — cloudflare.getsessiondetails Read
Fetch all chat messages of a session — cloudflare.getsessionchat Read
Fetch livestream session details using a session ID — cloudflare.get-v2-livestreamsession-session-meetingid-active-livestream Read
Fetch participants list of a session — cloudflare.getsessionparticipants Read
Fetch details of a participant — cloudflare.getparticipantdetails Read
Fetch summary of transcripts for a session — cloudflare.getsessionsummary Read
Generate summary of Transcripts for the session — cloudflare.post-sessions-session_id-summary Write
Fetch the complete transcript for a session — cloudflare.getsessiontranscript Read
Fetch all webhooks details — cloudflare.getallwebhooks Read
Add a webhook — cloudflare.addwebhook Write
Fetch all supported webhook events — cloudflare.getallwebhookevents Read
Fetch details of a webhook — cloudflare.getwebhook Read
Edit a webhook — cloudflare.editwebhook Write
Replace a webhook — cloudflare.replacewebhook Write
Check domain availability — cloudflare.sandbox-registrar-domain-discovery-check Write
Search for available domains — cloudflare.sandbox-registrar-domain-discovery-search Read
List extensions — cloudflare.sandbox-registrar-extension-list Read
Get extension — cloudflare.sandbox-registrar-extension-get Read
List Registrations — cloudflare.sandbox-registrar-domain-registration-list Read
Create Registration — cloudflare.sandbox-registrar-domain-registration-create Write
Get Registration — cloudflare.sandbox-registrar-domain-registration-get Read
Get Registration Status — cloudflare.sandbox-registrar-domain-registration-get-status Read
Get Update Status — cloudflare.sandbox-registrar-domain-registration-get-update-status Read
Check domain availability — cloudflare.registrar-domain-discovery-check Write
Search for available domains — cloudflare.registrar-domain-discovery-search Read
Check domain transfer eligibility — cloudflare.registrar-domain-discovery-transfer-check Write
List extensions — cloudflare.registrar-extension-list Read
Get extension — cloudflare.registrar-extension-get Read
List Registrations — cloudflare.registrar-domain-registration-list Read
Create Registration — cloudflare.registrar-domain-registration-create Write
Get Registration — cloudflare.registrar-domain-registration-get Read
Get Registration Status — cloudflare.registrar-domain-registration-get-status Read
Initiate Transfer — cloudflare.registrar-domain-transfer-in-create Write
Get Transfer Status — cloudflare.registrar-domain-transfer-get-status Read
Get Update Status — cloudflare.registrar-domain-registration-get-update-status Read
Get an account industry — cloudflare.reporting-industry-get Read
Update an account industry — cloudflare.reporting-industry-update Write
List reporting policies — cloudflare.reporting-policies-list Read
Get a reporting policy — cloudflare.reporting-policies-get Read
List generated reports — cloudflare.reporting-reports-list Read
Get a generated report — cloudflare.reporting-reports-get Read
Request Trace — cloudflare.account-request-tracer-request-trace Write
List applications — cloudflare.getresourcelibraryapplications Read
Create application — cloudflare.createresourcelibraryapplication Write
Look up applications in a rule sentence — cloudflare.lookupresourcelibraryapplications Write
Delete application — cloudflare.deleteresourcelibraryapplication Write
Get application — cloudflare.getresourcelibraryapplicationbyid Read
Update application — cloudflare.updateresourcelibraryapplication Write
List application categories — cloudflare.getresourcelibrarycategories Read
Get application category — cloudflare.getresourcelibrarycategorybyid Read
Get lists — cloudflare.lists-get-lists Read
Create a list — cloudflare.lists-create-a-list Write
Get bulk operation status — cloudflare.lists-get-bulk-operation-status Read
Delete a list — cloudflare.lists-delete-a-list Write
Get a list — cloudflare.lists-get-a-list Read
Update a list — cloudflare.lists-update-a-list Write
Delete list items — cloudflare.lists-delete-list-items Write
Get list items — cloudflare.lists-get-list-items Read
Create list items — cloudflare.lists-create-list-items Write
Update all list items — cloudflare.lists-update-all-list-items Write
Get a list item — cloudflare.lists-get-a-list-item Read
List account rulesets — cloudflare.listaccountrulesets Read
Create an account ruleset — cloudflare.createaccountruleset Write
Get an account entry point ruleset — cloudflare.getaccountentrypointruleset Read
Update an account entry point ruleset — cloudflare.updateaccountentrypointruleset Write
List an account entry point ruleset's versions — cloudflare.listaccountentrypointrulesetversions Read
Get an account entry point ruleset version — cloudflare.getaccountentrypointrulesetversion Read
Delete an account ruleset — cloudflare.deleteaccountruleset Write
Get an account ruleset — cloudflare.getaccountruleset Read
Update an account ruleset — cloudflare.updateaccountruleset Write
Delete an account ruleset rule — cloudflare.deleteaccountrulesetrule Write
List an account ruleset's versions — cloudflare.listaccountrulesetversions Read
Delete an account ruleset version — cloudflare.deleteaccountrulesetversion Write
Get an account ruleset version — cloudflare.getaccountrulesetversion Read
List an account ruleset version's rules by tag — cloudflare.listaccountrulesetversionrulesbytag Read
Create a Web Analytics site — cloudflare.web-analytics-create-site Write
List Web Analytics sites — cloudflare.web-analytics-list-sites Read
List Web Analytics site tags — cloudflare.web-analytics-list-site-tags Read
Validate a Web Analytics site hostname — cloudflare.web-analytics-validate-site-hostname Read
List Web Analytics zone tags — cloudflare.web-analytics-list-zone-tags Read
Delete a Web Analytics site — cloudflare.web-analytics-delete-site Write
Get a Web Analytics site — cloudflare.web-analytics-get-site Read
Update a Web Analytics site — cloudflare.web-analytics-update-site Write
Create a Web Analytics rule — cloudflare.web-analytics-create-rule Write
Delete a Web Analytics rule — cloudflare.web-analytics-delete-rule Write
Update a Web Analytics rule — cloudflare.web-analytics-update-rule Write
List rules in Web Analytics ruleset — cloudflare.web-analytics-list-rules Read
Update Web Analytics rules — cloudflare.web-analytics-modify-rules Write
List SCIM Groups — cloudflare.scim-groups-list Read
Create SCIM Group — cloudflare.scim-groups-create Write
Delete SCIM Group — cloudflare.scim-groups-delete Write
Get SCIM Group — cloudflare.scim-groups-get Read
Patch SCIM Group — cloudflare.scim-groups-patch Write
Replace SCIM Group — cloudflare.scim-groups-put Write
List SCIM Resource Types — cloudflare.scim-resource-types-list Read
Get SCIM Resource Type — cloudflare.scim-resource-types-get Read
List SCIM Schemas — cloudflare.scim-schemas-list Read
Get SCIM Schema — cloudflare.scim-schemas-get Read
Get SCIM Service Provider Config — cloudflare.scim-service-provider-config-get Read
List SCIM Users — cloudflare.scim-users-list Read
Create SCIM User — cloudflare.scim-users-create Write
Delete SCIM User — cloudflare.scim-users-delete Write
Get SCIM User — cloudflare.scim-users-get Read
Patch SCIM User — cloudflare.scim-users-patch Write
Replace SCIM User — cloudflare.scim-users-put Write
List ACLs — cloudflare.secondary-dns---acl--list-ac-ls Read
Create ACL — cloudflare.secondary-dns---acl--create-acl Write
Delete ACL — cloudflare.secondary-dns---acl--delete-acl Write
ACL Details — cloudflare.secondary-dns---acl--acl-details Read
Update ACL — cloudflare.secondary-dns---acl--update-acl Write
List Peers — cloudflare.secondary-dns---peer--list-peers Read
Create Peer — cloudflare.secondary-dns---peer--create-peer Write
Delete Peer — cloudflare.secondary-dns---peer--delete-peer Write
Peer Details — cloudflare.secondary-dns---peer--peer-details Read
Update Peer — cloudflare.secondary-dns---peer--update-peer Write
List TSIGs — cloudflare.secondary-dns---tsig--list-tsi-gs Read
Create TSIG — cloudflare.secondary-dns---tsig--create-tsig Write
Delete TSIG — cloudflare.secondary-dns---tsig--delete-tsig Write
TSIG Details — cloudflare.secondary-dns---tsig--tsig-details Read
Update TSIG — cloudflare.secondary-dns---tsig--update-tsig Write
View secret usage — cloudflare.secrets-store-quota Read
List account stores — cloudflare.secrets-store-list Read
Create a store — cloudflare.secrets-store-create Write
Delete a store — cloudflare.secrets-store-delete-by-id Write
Get a store by ID — cloudflare.secrets-store-get-store-by-id Read
Delete secrets — cloudflare.secrets-store-delete-bulk Write
List store secrets — cloudflare.secrets-store-secrets-list Read
Create a secret — cloudflare.secrets-store-secret-create Write
Delete a secret — cloudflare.secrets-store-secret-delete-by-id Write
Get a secret by ID — cloudflare.secrets-store-get-by-id Read
Patch a secret — cloudflare.secrets-store-patch-by-id Write
Duplicate Secret — cloudflare.secrets-store-duplicate-by-id Write
Retrieves Security Center Insights — cloudflare.get-security-center-insights Read
Retrieves Account Audit Log — cloudflare.get-security-center-account-audit-log Read
Retrieves Security Center Insight Counts by Class — cloudflare.get-security-center-insight-counts-by-class Read
Retrieves a Partner Security Center Insight Count — cloudflare.get-security-center-partner-insight-count Read
Get Recent Account Scans — cloudflare.get-security-center-account-scans Read
Start On-Demand Account Scan — cloudflare.start-security-center-account-scan Write
Retrieves Security Center Insight Counts by Severity — cloudflare.get-security-center-insight-counts-by-severity Read
Retrieves Security Center Insight Counts by Type — cloudflare.get-security-center-insight-counts-by-type Read
Retrieves Issue Audit Log — cloudflare.get-security-center-issue-audit-log Read
Updates Security Center Insight Classification — cloudflare.update-security-center-insight-classification Write
Retrieves Security Center Insight Context — cloudflare.get-security-center-insight-context Read
Archives Security Center Insight — cloudflare.archive-security-center-insight Write
Retrieves Partner Integration Settings — cloudflare.get-security-center-partner-settings Read
Updates Partner Integration Settings — cloudflare.update-security-center-partner-settings Write
Lists Partner-Discovered Shadow Zones — cloudflare.get-security-center-partner-shadow-zones Read
Lists Hosts in a Partner-Discovered Shadow Zone — cloudflare.get-security-center-partner-shadow-zone-hosts Read
Retrieves Account State — cloudflare.get-security-center-account-state Read
Updates Account State — cloudflare.update-security-center-account-state Write
List Image Resizing configurations for account — cloudflare.account-settings-list-transformations Read
Get Unique Transformations billing setting — cloudflare.account-settings-get-ut-billing-setting Read
Change Unique Transformations billing setting — cloudflare.account-settings-change-ut-billing-setting Write
List account shares — cloudflare.shares-list Read
Trigger a share creation — cloudflare.share-create Write
Trigger a share deletion — cloudflare.share-delete Write
Get account share by ID — cloudflare.shares-get-by-id Read
Trigger a share update — cloudflare.share-update Write
List share excluded recipients by share ID — cloudflare.share-excluded-recipients-list Read
Trigger an account exclusion from a share — cloudflare.share-excluded-recipient-create Write
Trigger excluded-account reconciliation on a share — cloudflare.share-excluded-recipients-update Write
Trigger an account un-exclusion from a share — cloudflare.share-excluded-recipient-delete Write
Get share excluded recipient by ID — cloudflare.share-excluded-recipients-get-by-id Read
List share recipients by share ID — cloudflare.share-recipients-list Read
Trigger recipient reconciliation on a share — cloudflare.share-recipients-update Write
Trigger a recipient removal from a share — cloudflare.share-recipient-delete Write
Get share recipient by ID — cloudflare.share-recipients-get-by-id Read
List share resources by share ID — cloudflare.share-resources-list Read
Trigger a resource addition to a share — cloudflare.share-resource-create Write
Trigger a resource deletion from a share — cloudflare.share-resource-delete Write
Get share resource by ID — cloudflare.share-resources-get-by-id Read
Trigger a resource metadata update in a share — cloudflare.share-resource-update Write
List jobs — cloudflare.slurper-list-jobs Read
Create a job — cloudflare.slurper-create-job Write
Abort all jobs — cloudflare.slurper-abort-all-jobs Write
Delete a job — cloudflare.slurper-delete-job Write
Get job details — cloudflare.slurper-get-job Read
Abort a job — cloudflare.slurper-abort-job Write
Get job logs — cloudflare.slurper-get-job-logs Read
Pause a job — cloudflare.slurper-pause-job Write
Get job progress — cloudflare.slurper-get-job-progress Read
Resume a job — cloudflare.slurper-resume-job Write
Check source connectivity — cloudflare.slurper-check-source-connectivity Write
Check target connectivity — cloudflare.slurper-check-target-connectivity Write
Get all SSO connectors — cloudflare.get-all-sso-connectors Read
Initialize new SSO connector — cloudflare.init-new-sso-connector Write
Delete SSO connector — cloudflare.delete-sso-connector Write
Get single SSO connector — cloudflare.get-sso-connector Read
Update SSO connector state — cloudflare.update-sso-connector-state Write
Begin SSO connector verification — cloudflare.begin-sso-connector-verification Write
List namespaces — cloudflare.workers-kv-namespace-list-namespaces Read
Create a namespace — cloudflare.workers-kv-namespace-create-a-namespace Write
Delete a namespace — cloudflare.workers-kv-namespace-remove-a-namespace Write
Get a namespace — cloudflare.workers-kv-namespace-get-a-namespace Read
Rename a namespace — cloudflare.workers-kv-namespace-rename-a-namespace Write
Write multiple key-value pairs — cloudflare.workers-kv-namespace-write-multiple-key-value-pairs Write
Delete multiple key-value pairs — cloudflare.workers-kv-namespace-delete-multiple-key-value-pairs Write
Get multiple key-value pairs — cloudflare.workers-kv-namespace-get-multiple-key-value-pairs Write
List keys in a namespace — cloudflare.workers-kv-namespace-list-a-namespace--s-keys Read
Get a key's metadata — cloudflare.workers-kv-namespace-read-the-metadata-for-a-key Read
Delete a key-value pair — cloudflare.workers-kv-namespace-delete-key-value-pair Write
List videos — cloudflare.stream-videos-list-videos Read
Initiate video uploads using TUS — cloudflare.stream-videos-initiate-video-uploads-using-tus Write
Clip videos given a start and end time — cloudflare.stream-video-clipping-clip-videos-given-a-start-and-end-time Write
Upload videos from a URL — cloudflare.stream-videos-upload-videos-from-a-url Write
Upload videos via direct upload URLs — cloudflare.stream-videos-upload-videos-via-direct-upload-ur-ls Write
List signing keys — cloudflare.stream-signing-keys-list-signing-keys Read
Create signing keys — cloudflare.stream-signing-keys-create-signing-keys Write
Delete signing keys — cloudflare.stream-signing-keys-delete-signing-keys Write
List live inputs — cloudflare.stream-live-inputs-list-live-inputs Read
Create a live input — cloudflare.stream-live-inputs-create-a-live-input Write
Delete a live input — cloudflare.stream-live-inputs-delete-a-live-input Write
Retrieve a live input — cloudflare.stream-live-inputs-retrieve-a-live-input Read
Update a live input — cloudflare.stream-live-inputs-update-a-live-input Write
Disable a live input — cloudflare.stream-live-inputs-disable-a-live-input Write
Enable a live input — cloudflare.stream-live-inputs-enable-a-live-input Write
List all outputs associated with a specified live input — cloudflare.stream-live-inputs-list-all-outputs-associated-with-a-spec-7c0ac43140 Read
Create a new output, connected to a live input — cloudflare.stream-live-inputs-create-a-new-output--connected-to-a-live-input Write
Delete an output — cloudflare.stream-live-inputs-delete-an-output Write
Update an output — cloudflare.stream-live-inputs-update-an-output Write
Rotate keys for a live input — cloudflare.stream-live-inputs-rotate-keys-for-a-live-input Write
Storage use — cloudflare.stream-videos-storage-usage Read
Get account Stream usage — cloudflare.usage-analytics-get-account-stream-usage Read
List watermark profiles — cloudflare.stream-watermark-profile-list-watermark-profiles Read
Create watermark profiles via basic upload — cloudflare.stream-watermark-profile-create-watermark-profiles-via-basic-upload Write
Delete watermark profiles — cloudflare.stream-watermark-profile-delete-watermark-profiles Write
Watermark profile details — cloudflare.stream-watermark-profile-watermark-profile-details Read
Delete webhooks — cloudflare.stream-webhook-delete-webhooks Write
View webhook — cloudflare.stream-webhook-view-webhooks Read
Create VOD webhooks — cloudflare.stream-webhook-create-webhooks Write
Delete video — cloudflare.stream-videos-delete-video Write
Retrieve video details — cloudflare.stream-videos-retrieve-video-details Read
Edit video details — cloudflare.stream-videos-update-video-details Write
List additional audio tracks on a video — cloudflare.list-audio-tracks Read
Add audio tracks to a video — cloudflare.add-audio-track Write
Delete additional audio tracks on a video — cloudflare.delete-audio-tracks Write
Edit additional audio tracks on a video — cloudflare.edit-audio-tracks Write
List captions or subtitles — cloudflare.stream-subtitles.-captions-list-captions-or-subtitles Read
Delete captions or subtitles — cloudflare.stream-subtitles.-captions-delete-captions-or-subtitles Write
List captions or subtitles for a provided language — cloudflare.stream-subtitles.-captions-get-caption-or-subtitle-for-language Read
Generate captions or subtitles for a provided language via AI — cloudflare.stream-subtitles.-captions-generate-caption-or-subtitle-for-language Write
Return WebVTT captions for a provided language — cloudflare.stream-subtitles.-captions-get-vtt-caption-or-subtitle Read
Delete downloads — cloudflare.stream-mp4-downloads-delete-downloads Write
List downloads — cloudflare.stream-mp4-downloads-list-downloads Read
Create downloads — cloudflare.stream-mp4-downloads-create-downloads Write
Delete download — cloudflare.stream-downloads-delete-type-specific-downloads Write
Create download — cloudflare.stream-downloads-create-type-specific-downloads Write
Deprecated: Retrieve legacy embed code HTML — cloudflare.stream-videos-retreieve-embed-code-html Read
Create signed URL tokens for videos — cloudflare.stream-videos-create-signed-url-tokens-for-videos Write
List Subscriptions — cloudflare.account-subscriptions-list-subscriptions Read
Create Subscription — cloudflare.account-subscriptions-create-subscription Write
Cancel Delayed Downgrade — cloudflare.account-subscriptions-cancel-delayed-downgrade Write
Delete Subscription — cloudflare.account-subscriptions-delete-subscription Write
Get Subscription — cloudflare.account-subscriptions-get-subscription Read
Update Subscription — cloudflare.account-subscriptions-update-subscription Write
Append Subscription Action — cloudflare.account-subscriptions-action-append-subscription Write
Get Cancel Reason — cloudflare.account-subscriptions-get-cancel-reason Read
Create Cancel Reason — cloudflare.account-subscriptions-create-cancel-reason Write
Delete tags from an account-level resource — cloudflare.tags-delete Write
Get tags for an account-level resource — cloudflare.tags-get Read
Set tags for an account-level resource — cloudflare.tags-set Write
List tag keys — cloudflare.tags-list-keys Read
List tagged resources — cloudflare.tags-list Read
List tag key summary — cloudflare.tags-list-key-summary Read
List tag values — cloudflare.tags-list-values Read
List tunnel routes — cloudflare.tunnel-route-list-tunnel-routes Read
Create a tunnel route — cloudflare.tunnel-route-create-a-tunnel-route Write
Get tunnel route by IP — cloudflare.tunnel-route-get-tunnel-route-by-ip Read
Delete a tunnel route — cloudflare.tunnel-route-delete-a-tunnel-route Write
Get tunnel route — cloudflare.tunnel-route-get-tunnel-route Read
Update a tunnel route — cloudflare.tunnel-route-update-a-tunnel-route Write
List virtual networks — cloudflare.tunnel-virtual-network-list-virtual-networks Read
Create a virtual network — cloudflare.tunnel-virtual-network-create-a-virtual-network Write
Delete a virtual network — cloudflare.tunnel-virtual-network-delete Write
Get a virtual network — cloudflare.tunnel-virtual-network-get Read
Update a virtual network — cloudflare.tunnel-virtual-network-update Write
List Tokens — cloudflare.account-api-tokens-list-tokens Read
Create Token — cloudflare.account-api-tokens-create-token Write
List Permission Groups — cloudflare.account-api-tokens-list-permission-groups Read
Verify Token — cloudflare.account-api-tokens-verify-token Read
Delete Token — cloudflare.account-api-tokens-delete-token Write
Token Details — cloudflare.account-api-tokens-token-details Read
Roll Token — cloudflare.account-api-tokens-roll-token Write
Delete script triggers — cloudflare.wor-delete-script-triggers Write
Get script triggers — cloudflare.wor-get-script-triggers Read
Add script triggers — cloudflare.wor-add-script-triggers Write
Replace script triggers — cloudflare.wor-replace-script-triggers Write
List All Tunnels — cloudflare.cloudflare-tunnel-list-all-tunnels Read
Bulk create URL Scans — cloudflare.urlscanner-create-scan-bulk-v2 Write
Get URL scan's DOM — cloudflare.urlscanner-get-scan-dom-v2 Read
Get URL scan's HAR — cloudflare.urlscanner-get-scan-har-v2 Read
Get raw response — cloudflare.urlscanner-get-response-v2 Read
Get URL scan — cloudflare.urlscanner-get-scan-v2 Read
Create URL Scan — cloudflare.urlscanner-create-scan-v2 Write
Get screenshot — cloudflare.urlscanner-get-scan-screenshot-v2 Read
Search URL scans — cloudflare.urlscanner-search-scans-v2 Read
List Vectorize Indexes — cloudflare.vectorize-list-vectorize-indexes Read
Create Vectorize Index — cloudflare.vectorize-create-vectorize-index Write
Delete Vectorize Index — cloudflare.vectorize-delete-vectorize-index Write
Get Vectorize Index — cloudflare.vectorize-get-vectorize-index Read
Delete Vectors By Identifier — cloudflare.vectorize-delete-vectors-by-id Write
Get Vectors By Identifier — cloudflare.vectorize-get-vectors-by-id Write
Get Vectorize Index Info — cloudflare.vectorize-index-info Read
List Vectors — cloudflare.vectorize-list-vectors Read
Create Metadata Index — cloudflare.vectorize-create-metadata-index Write
Delete Metadata Index — cloudflare.vectorize-delete-metadata-index Write
List Metadata Indexes — cloudflare.vectorize-list-metadata-indexes Read
Query Vectors — cloudflare.vectorize-query-vector Write
List credential sets — cloudflare.list-credential-sets Read
Create credential set — cloudflare.create-credential-set Write
Delete credential set — cloudflare.delete-credential-set Write
Get credential set — cloudflare.get-credential-set Read
Edit credential set — cloudflare.edit-credential-set Write
Update credential set — cloudflare.update-credential-set Write
List credentials — cloudflare.list-credentials Read
Create credential — cloudflare.create-credential Write
Delete credential — cloudflare.delete-credential Write
Get credential — cloudflare.get-credential Read
Edit credential — cloudflare.edit-credential Write
Update credential — cloudflare.update-credential Write
List scans — cloudflare.list-scans Read
Create scan — cloudflare.create-scan Write
Delete scan — cloudflare.delete-scan Write
Get scan — cloudflare.get-scan Read
List target environments — cloudflare.list-target-environments Read
Create target environment — cloudflare.create-target-environment Write
Delete target environment — cloudflare.delete-target-environment Write
Get target environment — cloudflare.get-target-environment Read
Edit target environment — cloudflare.edit-target-environment Write
Update target environment — cloudflare.update-target-environment Write
List waiting rooms for account — cloudflare.waiting-room-list-waiting-rooms-account Read
List Mesh nodes — cloudflare.cloudflare-tunnel-list-warp-connector-tunnels Read
Create a Mesh node — cloudflare.cloudflare-tunnel-create-a-warp-connector-tunnel Write
Delete a Mesh node — cloudflare.cloudflare-tunnel-delete-a-warp-connector-tunnel Write
Get a Mesh node — cloudflare.cloudflare-tunnel-get-a-warp-connector-tunnel Read
Update a Mesh node — cloudflare.cloudflare-tunnel-update-a-warp-connector-tunnel Write
Get Mesh node HA configuration — cloudflare.cloudflare-tunnel-configuration-get-warp-connector-configuration Read
Update Mesh node HA configuration — cloudflare.cloudflare-tunnel-configuration-update-warp-connector-configuration Write
List Mesh node connections — cloudflare.cloudflare-tunnel-list-warp-connector-tunnel-connections Read
Get a Mesh node connector — cloudflare.cloudflare-tunnel-get-warp-connector-tunnel-connector Read
Trigger a manual failover for a Mesh node — cloudflare.cloudflare-tunnel-manual-failover-warp-connector-tunnel Write
Get a Mesh node token — cloudflare.cloudflare-tunnel-get-a-warp-connector-tunnel-token Read
Fetch Workers Account Settings — cloudflare.worker-account-settings-fetch-worker-account-settings Read
Configure Workers Account Settings — cloudflare.worker-account-settings-create-worker-account-settings Write
List Workers for Platforms Dispatch Namespaces — cloudflare.namespace-worker-list Read
Create Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-create Write
Delete Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-delete-namespace Write
Get Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-get-namespace Read
Patch Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-patch-namespace Write
Update Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-put-namespace Write
Delete Workers for Platforms Scripts — cloudflare.namespace-worker-delete-scripts Write
List Workers for Platforms Scripts — cloudflare.namespace-worker-list-scripts Read
Delete Workers for Platforms Script — cloudflare.namespace-worker-script-delete-worker Write
Get Workers for Platforms Script details — cloudflare.namespace-worker-script-worker-details Read
Create Workers for Platforms Assets Upload Session — cloudflare.namespace-worker-script-update-create-assets-upload-session Write
Get Workers for Platforms Script Bindings — cloudflare.namespace-worker-get-script-bindings Read
Get Workers for Platforms Script Content — cloudflare.namespace-worker-get-script-content Read
List Workers for Platforms Script Secrets — cloudflare.namespace-worker-list-script-secrets Read
Add a secret to a Workers for Platforms script — cloudflare.namespace-worker-put-script-secrets Write
Patch multiple Workers for Platforms script secrets — cloudflare.namespace-worker-patch-script-secrets-bulk Write
Delete Workers for Platforms script secret — cloudflare.namespace-worker-delete-script-secret Write
Get Workers for Platforms Script Secret — cloudflare.namespace-worker-get-script-secrets Read
Get Workers for Platforms Script Settings — cloudflare.namespace-worker-get-script-settings Read
List Workers for Platforms Script Tags — cloudflare.namespace-worker-get-script-tags Read
Replace Workers for Platforms Script Tags — cloudflare.namespace-worker-put-script-tags Write
Update Workers for Platforms Script Tag — cloudflare.namespace-worker-patch-script-tag Write
Create Workers for Platforms Script Tag — cloudflare.namespace-worker-put-script-tag Write
List Worker Domains — cloudflare.workers.domains.list Read
Attach Worker Domain — cloudflare.workers.domains.update Write
Detach Worker Domain — cloudflare.workers.domains.delete Write
Get Worker Domain — cloudflare.workers.domains.get Read
List Durable Object Namespaces — cloudflare.durable-objects-namespace-list-namespaces Read
List Objects in a Durable Object namespace — cloudflare.durable-objects-namespace-list-objects Read
Query a Durable Object — cloudflare.durable-objects-namespace-query Write
List Agent sessions — cloudflare.agents.sessions.list Read
List Agent session runs — cloudflare.agents.sessions.runs.list Read
Get Destinations — cloudflare.destination.list Read
Create Destination — cloudflare.destination.create Write
Delete Destination — cloudflare.destinations.delete Write
Update Destination — cloudflare.destination.update Write
List detected issues — cloudflare.issues.list Read
List issue automations — cloudflare.issues.automations.list Read
Create an issue automation — cloudflare.issues.automations.create Write
Delete an issue automation — cloudflare.issues.automations.delete Write
Get an issue automation — cloudflare.issues.automations.get Read
Update an issue automation — cloudflare.issues.automations.update Write
Create an issue group — cloudflare.issues.groups.create Write
Dissolve an issue group — cloudflare.issues.groups.delete Write
Add issue group members — cloudflare.issues.groups.members.add Write
Remove an issue group member — cloudflare.issues.groups.members.remove Write
Summarize detected issues — cloudflare.issues.summary Read
Get an issue — cloudflare.issues.get Read
Modify an issue — cloudflare.issues.patch Write
Notify about an issue — cloudflare.issues.notificationruns.create Write
List issue occurrences — cloudflare.issues.occurrences.list Read
List Metrics Exports — cloudflare.metricsexport.list Read
Upsert Metrics Exports — cloudflare.metricsexport.upsert Write
List queries — cloudflare.queries.list Read
Save query — cloudflare.queries.post Write
Delete query — cloudflare.queries.delete Write
Get query — cloudflare.queries.get Read
Update query — cloudflare.queries.patch Write
Create a sharable link to a query result — cloudflare.shared.query.post Write
View a query that has been shared — cloudflare.shared.query.get Read
List keys — cloudflare.telemetry.keys.list Write
Prepare live tail — cloudflare.telemetry.live-tail.post Write
Live tail heartbeat — cloudflare.telemetry.live-tail.heartbeat.get Write
Run a query — cloudflare.telemetry.query Write
List values — cloudflare.telemetry.values.list Write
Get event count — cloudflare.usage.get Read
List Workers Smart Placement Regions — cloudflare.worker-placement-list-regions Read
List Worker Scripts — cloudflare.worker-script-list-workers Read
Search Worker Scripts — cloudflare.worker-script-search-workers Read
Delete Worker — cloudflare.worker-script-delete-worker Write
Create Worker Assets Upload Session — cloudflare.worker-script-update-create-assets-upload-session Write
Get Worker Script Content — cloudflare.worker-script-get-content Read
List Worker Deployments — cloudflare.worker-deployments-list-deployments Read
Create Worker Deployment — cloudflare.worker-deployments-create-deployment Write
Delete Worker Deployment — cloudflare.worker-deployments-delete-deployment Write
Get Worker Deployment — cloudflare.worker-deployments-get-deployment Read
Get Worker Script Schedules (Cron Triggers) — cloudflare.worker-cron-trigger-get-cron-triggers Read
Update Worker Script Schedules (Cron Triggers) — cloudflare.worker-cron-trigger-update-cron-triggers Write
Get Worker Script Settings — cloudflare.worker-script-settings-get-settings Read
Patch Worker Script Settings — cloudflare.worker-script-settings-patch-settings Write
List secrets bound to a Worker script — cloudflare.worker-list-script-secrets Read
Add a secret to a Worker script — cloudflare.worker-put-script-secret Write
Patch multiple Worker script secrets — cloudflare.worker-patch-script-secrets-bulk Write
Delete Worker script secret — cloudflare.worker-delete-script-secret Write
Get a secret binding — cloudflare.worker-get-script-secret Read
Get Worker Script and Version Settings — cloudflare.worker-script-get-settings Read
Delete Worker Script Subdomain — cloudflare.worker-script-delete-subdomain Write
Get Worker Script Subdomain — cloudflare.worker-script-get-subdomain Read
Update Worker Script Subdomain — cloudflare.worker-script-post-subdomain Write
List Worker Tails — cloudflare.worker-tail-logs-list-tails Read
Start Worker Tail — cloudflare.worker-tail-logs-start-tail Write
Delete Worker Tail — cloudflare.worker-tail-logs-delete-tail Write
Get Worker Script Usage Model — cloudflare.worker-script-fetch-usage-model Read
Replace Worker Script Usage Model — cloudflare.worker-script-update-usage-model Write
List Versions — cloudflare.worker-versions-list-versions Read
Get Worker Script Version — cloudflare.worker-versions-get-version-detail Read
Get Worker Environment Script Content — cloudflare.worker-environment-get-script-content Read
Get Worker Environment Settings — cloudflare.worker-script-environment-get-settings Read
Patch Worker Environment Settings — cloudflare.worker-script-environment-patch-settings Write
Delete Workers Subdomain — cloudflare.worker-subdomain-delete-subdomain Write
Get a Workers Subdomain — cloudflare.worker-subdomain-get-subdomain Read
Create a Workers Subdomain — cloudflare.worker-subdomain-create-subdomain Write
List Workers — cloudflare.listworkers Read
Create Worker — cloudflare.createworker Write
Delete Worker — cloudflare.deleteworker Write
Get Worker — cloudflare.getworker Read
Edit Worker — cloudflare.editworker Write
Update Worker — cloudflare.updateworker Write
List Previews — cloudflare.workers.previews.list Read
Create Preview — cloudflare.workers.previews.create Write
Delete Preview — cloudflare.workers.previews.delete Write
Get Preview — cloudflare.workers.previews.get Read
Edit Preview — cloudflare.workers.previews.edit Write
Update Preview — cloudflare.workers.previews.update Write
List Preview Deployments — cloudflare.workers.previews.deployments.list Read
Create Preview Deployment — cloudflare.workers.previews.deployments.create Write
Patch Latest Preview Deployment — cloudflare.workers.previews.deployments.patchlatest Write
Delete Preview Deployment — cloudflare.workers.previews.deployments.delete Write
Get Preview Deployment — cloudflare.workers.previews.deployments.get Read
List Worker Versions — cloudflare.listworkerversions Read
Create Worker Version — cloudflare.createworkerversion Write
Get Latest Worker Version — cloudflare.getlatestworkerversion Read
Patch Latest Worker Version — cloudflare.patchlatestworkerversion Write
Delete Worker Version — cloudflare.deleteworkerversion Write
Get Worker Version — cloudflare.getworkerversion Read
List all Workflows — cloudflare.wor-list-workflows Read
List concurrency keys — cloudflare.wor-list-concurrency-keys Read
Create a concurrency key — cloudflare.wor-create-concurrency-key Write
Delete a concurrency key — cloudflare.wor-delete-concurrency-key Write
Get concurrency key details — cloudflare.wor-get-concurrency-key Read
Update a concurrency key — cloudflare.wor-update-concurrency-key Write
Get account settings — cloudflare.wor-get-workflow-settings Read
Update account settings — cloudflare.wor-update-workflow-settings Write
Deletes a Workflow — cloudflare.wor-delete-workflow Write
Get Workflow details — cloudflare.wor-get-workflow-details Read
Create/modify Workflow — cloudflare.wor-create-or-modify-workflow Write
List of workflow instances — cloudflare.wor-list-workflow-instances Read
Create a new workflow instance — cloudflare.wor-create-new-workflow-instance Write
Batch create new Workflow instances — cloudflare.wor-batch-create-workflow-instance Write
Batch delete instances of a workflow — cloudflare.wor-batch-delete-workflow-instances Write
Batch terminate instances of a workflow — cloudflare.wor-batch-terminate-workflow-instances Write
Get status of the job responsible for terminate all instances of a workflow — cloudflare.wor-status-terminate-workflow-instances Read
Delete a workflow instance — cloudflare.wor-delete-workflow-instance Write
Get logs and status from instance — cloudflare.wor-describe-workflow-instance Read
Send event to instance — cloudflare.wor-send-event-workflow-instance Write
Change status of instance — cloudflare.wor-change-status-workflow-instance Write
Get full step output from instance — cloudflare.wor-get-workflow-instance-step Read
Create a workflow instance event subscription token — cloudflare.wor-create-workflow-instance-subscription-token Read
List deployed Workflow versions — cloudflare.wor-list-workflow-versions Read
Get Workflow version details — cloudflare.wor-describe-workflow-versions Read
Get Workflow version dag — cloudflare.wor-describe-workflow-versions-dag Read
Get Workflow version graph — cloudflare.wor-describe-workflow-versions-graph Read
Get Zero Trust Connectivity Settings — cloudflare.zero-trust-accounts-get-connectivity-settings Read
Updates the Zero Trust Connectivity Settings — cloudflare.zero-trust-accounts-patch-connectivity-settings Write
List hostname routes — cloudflare.zero-trust-networks-route-hostname-list Read
Create hostname route — cloudflare.zero-trust-networks-route-hostname-create Write
Delete hostname route — cloudflare.zero-trust-networks-route-hostname-delete Write
Get hostname route — cloudflare.zero-trust-networks-route-hostname-get Read
Update hostname route — cloudflare.zero-trust-networks-route-hostname-update Write
List Subnets — cloudflare.zero-trust-networks-subnets-list Read
Get Cloudflare Source Subnet — cloudflare.zero-trust-networks-subnet-get-cloudflare-source Read
Update Cloudflare Source Subnet — cloudflare.zero-trust-networks-subnet-update-cloudflare-source Write
Get Initial Resolved IP Subnet — cloudflare.zero-trust-networks-subnet-get-initial-resolved-ip Read
Update Initial Resolved IP Subnet — cloudflare.zero-trust-networks-subnet-update-initial-resolved-ip Write
Create WARP IP subnet — cloudflare.zero-trust-networks-subnet-create-warp Write
Delete WARP IP subnet — cloudflare.zero-trust-networks-subnet-delete-warp Write
Get WARP IP subnet — cloudflare.zero-trust-networks-subnet-get-warp Read
Update WARP IP subnet — cloudflare.zero-trust-networks-subnet-update-warp Write
Get all behaviors and associated configuration — cloudflare.dlp-risk-score-behaviors-get Read
Update configuration for risk behaviors — cloudflare.dlp-risk-score-behaviors-put Write
List all risk score integrations for the account. — cloudflare.dlp-zt-risk-score-integration-list Read
Create new risk score integration. — cloudflare.dlp-zt-risk-score-integration-create Write
Get risk score integration by reference id. — cloudflare.dlp-zt-risk-score-integration-get-by-reference-id Read
Delete a risk score integration. — cloudflare.dlp-zt-risk-score-integration-delete Write
Get risk score integration by id. — cloudflare.dlp-zt-risk-score-integration-get Read
Update a risk score integration. — cloudflare.dlp-zt-risk-score-integration-update Write
Get risk score info for all users in the account — cloudflare.dlp-risk-score-summary-get Read
Get risk event/score information for a specific user — cloudflare.dlp-risk-score-summary-get-for-user Read
Clear the risk score for a particular user — cloudflare.dlp-risk-score-reset-post Write
Query analytics datasets — cloudflare.sql-api-query-get Read
Query analytics datasets — cloudflare.sql-api-query-post Write
List available analytics datasets — cloudflare.sql-api-introspection Read
Validate Billing Address — cloudflare.billing-validate-address Write
Get Rate Plan by Public Key — cloudflare.billing-get-rate-plan Read
List Certificates — cloudflare.origin-ca-list-certificates Read
Create Certificate — cloudflare.origin-ca-create-certificate Write
Revoke Certificate — cloudflare.origin-ca-revoke-certificate Write
Get Certificate — cloudflare.origin-ca-get-certificate Read
List category APIs — cloudflare.cws-list-category-apis Read
List category applications — cloudflare.cws-list-category-applications Read
List application versions — cloudflare.cws-list-category-application-versions Read
Get the latest application version — cloudflare.cws-get-latest-category-application-version Read
Get an application version — cloudflare.cws-get-category-application-version Read
List category operations — cloudflare.cws-list-category-operations Read
Get filter fields — cloudflare.cws-get-filter-schema Read
Cloudflare/JD Cloud IP Details — cloudflare.cloudflare-ips-cloudflare-ip-details Read
List Memberships — cloudflare.user--s-account-memberships-list-memberships Read
Delete Membership — cloudflare.user--s-account-memberships-delete-membership Write
Membership Details — cloudflare.user--s-account-memberships-membership-details Read
Update Membership — cloudflare.user--s-account-memberships-update-membership Write
List OAuth Scopes — cloudflare.oauth-scopes-list Read
List organizations the user has access to — cloudflare.organization_listorganizations Read
Create organization — cloudflare.organizations_createuserorganization Write
Delete organization — cloudflare.organizations_delete Write
Get organization — cloudflare.organizations_retrieve Read
Update organization — cloudflare.organizations_modify Write
List organization accounts — cloudflare.organizations_getaccounts Read
Get Organization Usage (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-get-organization-usage Read
Handle organization invite — cloudflare.organizations_handleorganizationinvite Write
Get organization audit logs (Version 2) — cloudflare.audit-logs-v2-get-organization-audit-logs Read
Get resource change history from an organization audit log entry (Version 2) — cloudflare.audit-logs-v2-get-organization-audit-log-history Read
List organization members — cloudflare.members_list Read
Create organization member — cloudflare.members_create Write
Delete organization member — cloudflare.members_delete Write
Get organization member — cloudflare.members_retrieve Read
Batch create organization members — cloudflare.members_batchcreate Write
Get organization profile — cloudflare.organizations_getprofile Read
Modify organization profile. — cloudflare.organizations_modifyprofile Write
List organization shares — cloudflare.organization-shares-list Read
Check missing assets — cloudflare.pages-assets-check-missing Write
Upload asset — cloudflare.pages-assets-upload Write
Upsert asset hashes — cloudflare.pages-assets-upsert-hashes Write
Get agent readiness summary — cloudflare.radar-get-agent-readiness-summary Read
Get AI bots HTTP requests distribution by dimension — cloudflare.radar-get-ai-bots-summary Read
Get AI bots HTTP requests time series — cloudflare.radar-get-ai-bots-timeseries Read
Get time series distribution of AI bots HTTP requests by dimension. — cloudflare.radar-get-ai-bots-timeseries-group Read
Get Workers AI inference distribution by dimension — cloudflare.radar-get-ai-inference-summary Read
Get time series distribution of Workers AI inference by dimension. — cloudflare.radar-get-ai-inference-timeseries-group Read
Get AI markdown for agents reduction ratio summary — cloudflare.radar-get-ai-markdown-for-agents-summary Read
Get AI markdown for agents reduction ratio time series — cloudflare.radar-get-ai-markdown-for-agents-timeseries Read
Get latest annotations — cloudflare.radar-get-annotations Read
Get latest Internet outages and anomalies — cloudflare.radar-get-annotations-outages Read
Get the number of outages by location — cloudflare.radar-get-annotations-outages-top Read
Get annotation by ID — cloudflare.radar-get-annotation-by-id Read
Get AS112 summary by dimension — cloudflare.radar-get-dns-as112-summary Read
Get AS112 DNS queries time series — cloudflare.radar-get-dns-as112-timeseries Read
Get AS112 time series grouped by dimension — cloudflare.radar-get-dns-as112-timeseries-group Read
Get top locations by AS112 DNS queries — cloudflare.radar-get-dns-as112-top-locations Read
Get top locations by AS112 DNS queries with DNSSEC support — cloudflare.radar-get-dns-as112-top-locations-by-dnssec Read
Get top locations by AS112 DNS queries with EDNS support — cloudflare.radar-get-dns-as112-top-locations-by-edns Read
Get top locations by AS112 DNS queries for an IP version — cloudflare.radar-get-dns-as112-top-locations-by-ip-version Read
Get layer 3 attacks summary by dimension — cloudflare.radar-get-attacks-layer3-summary Read
Get layer 3 attacks by bytes time series — cloudflare.radar-get-attacks-layer3-timeseries-by-bytes Read
Get layer 3 attacks time series grouped by dimension — cloudflare.radar-get-attacks-layer3-timeseries-group Read
Get top layer 3 attack pairs (origin and target locations) — cloudflare.radar-get-attacks-layer3-top-attacks Read
Get top origin locations of layer 3 attacks — cloudflare.radar-get-attacks-layer3-top-origin-locations Read
Get top target locations of layer 3 attacks — cloudflare.radar-get-attacks-layer3-top-target-locations Read
Get layer 7 attacks summary by dimension — cloudflare.radar-get-attacks-layer7-summary Read
Get layer 7 attacks time series — cloudflare.radar-get-attacks-layer7-timeseries Read
Get layer 7 attacks time series grouped by dimension — cloudflare.radar-get-attacks-layer7-timeseries-group Read
Get top origin ASes of layer 7 attacks — cloudflare.radar-get-attacks-layer7-top-origin-as Read
Get top layer 7 attack pairs (origin and target locations) — cloudflare.radar-get-attacks-layer7-top-attacks Read
Get top origin locations of layer 7 attacks — cloudflare.radar-get-attacks-layer7-top-origin-location Read
Get top target locations of layer 7 attacks — cloudflare.radar-get-attacks-layer7-top-target-location Read
Get BGP hijack events — cloudflare.radar-get-bgp-hijacks-events Read
Get announced IP address space time series — cloudflare.radar-get-bgp-ips-timeseries Read
Get top ASes by announced IP space — cloudflare.radar-get-bgp-ips-top-ases Read
Get BGP route leak events — cloudflare.radar-get-bgp-route-leak-events Read
List ASes from global routing tables — cloudflare.radar-get-bgp-routes-asns Read
Get Multi-Origin AS (MOAS) prefixes — cloudflare.radar-get-bgp-pfx2as-moas Read
Get tier-1 path segments for an AS — cloudflare.radar-get-bgp-routes-paths Read
Get prefix-to-ASN mapping — cloudflare.radar-get-bgp-pfx2as Read
Get real-time BGP routes for a prefix — cloudflare.radar-get-bgp-routes-realtime Read
Get BGP routing table stats — cloudflare.radar-get-bgp-routes-stats Read
Get upstream composition time series for an AS — cloudflare.radar-get-bgp-routes-upstreams-timeseries Read
Get ASPA changes over time — cloudflare.radar-get-bgp-rpki-aspa-changes Read
Get ASPA objects snapshot — cloudflare.radar-get-bgp-rpki-aspa-snapshot Read
Get ASPA count time series — cloudflare.radar-get-bgp-rpki-aspa-timeseries Read
Get RPKI ROA deployment time series — cloudflare.radar-get-bgp-rpki-roas-timeseries Read
Get BGP time series — cloudflare.radar-get-bgp-timeseries Read
Get top ASes by BGP updates — cloudflare.radar-get-bgp-top-ases Read
Get top ASes by prefix count — cloudflare.radar-get-bgp-top-asns-by-prefixes Read
Get top prefixes by BGP updates — cloudflare.radar-get-bgp-top-prefixes Read
List bots — cloudflare.radar-get-bots Read
Get crawler HTTP request distribution by dimension — cloudflare.radar-get-crawlers-summary Read
Get time series of crawler HTTP request distribution by dimension — cloudflare.radar-get-crawlers-timeseries-group Read
Get bots HTTP requests distribution by dimension — cloudflare.radar-get-bots-summary Read
Get bots HTTP requests time series — cloudflare.radar-get-bots-timeseries Read
Get time series distribution of bots HTTP requests by dimension. — cloudflare.radar-get-bots-timeseries-group Read
Get bot details — cloudflare.radar-get-bot-details Read
List certificate authorities — cloudflare.radar-get-certificate-authorities Read
Get certificate authority details — cloudflare.radar-get-certificate-authority-details Read
List certificate logs — cloudflare.radar-get-certificate-logs Read
Get certificate log details — cloudflare.radar-get-certificate-log-details Read
Get certificate distribution by dimension — cloudflare.radar-get-ct-summary Read
Get certificates time series — cloudflare.radar-get-ct-timeseries Read
Get time series of certificate distribution by dimension — cloudflare.radar-get-ct-timeseries-group Read
List datasets — cloudflare.radar-get-reports-datasets Read
Get dataset download URL — cloudflare.radar-post-reports-dataset-download-url Write
Get dataset CSV stream — cloudflare.radar-get-reports-dataset-download Read
Get DNS summary by dimension — cloudflare.radar-get-dns-summary Read
Get DNS queries time series — cloudflare.radar-get-dns-timeseries Read
Get DNS time series grouped by dimension — cloudflare.radar-get-dns-timeseries-group Read
Get top ASes by DNS queries — cloudflare.radar-get-dns-top-ases Read
Get top locations by DNS queries — cloudflare.radar-get-dns-top-locations Read
Get email routing summary by dimension — cloudflare.radar-get-email-routing-summary Read
Get email routing time series grouped by dimension — cloudflare.radar-get-email-routing-timeseries-group Read
Get email security summary by dimension — cloudflare.radar-get-email-security-summary Read
Get email security time series grouped by dimension — cloudflare.radar-get-email-security-timeseries-group Read
Get top TLDs by email message volume — cloudflare.radar-get-email-security-top-tlds-by-messages Read
Get top TLDs by email malicious classification — cloudflare.radar-get-email-security-top-tlds-by-malicious Read
Get top TLDs by email spam classification — cloudflare.radar-get-email-security-top-tlds-by-spam Read
Get top TLDs by email spoof classification — cloudflare.radar-get-email-security-top-tlds-by-spoof Read
List autonomous systems — cloudflare.radar-get-entities-asn-list Read
Get AS rankings by botnet threat feed activity — cloudflare.radar-get-as-botnet-threat-feed Read
Get AS details by IP address — cloudflare.radar-get-entities-asn-by-ip Read
Get AS details by ASN — cloudflare.radar-get-entities-asn-by-id Read
Get IRR AS-SETs that an AS is a member of — cloudflare.radar-get-asns-as-set Read
Get AS-level relationships by ASN — cloudflare.radar-get-asns-rel Read
Get IP address details — cloudflare.radar-get-entities-ip Read
List locations — cloudflare.radar-get-entities-locations Read
Get location details — cloudflare.radar-get-entities-location-by-alpha2 Read
List Geolocations — cloudflare.radar-get-geolocations Read
Get Geolocation details — cloudflare.radar-get-geolocation-details Read
Get HTTP requests summary by dimension — cloudflare.radar-get-http-summary Read
Get HTTP requests time series — cloudflare.radar-get-http-timeseries Read
Get HTTP requests time series grouped by dimension — cloudflare.radar-get-http-timeseries-group Read
Get top ASes by HTTP requests — cloudflare.radar-get-http-top-ases-by-http-requests Read
Get top ASes by HTTP requests for a bot class — cloudflare.radar-get-http-top-ases-by-bot-class Read
Get top ASes by HTTP requests for a browser family — cloudflare.radar-get-http-top-ases-by-browser-family Read
Get top ASes by HTTP requests for a device type — cloudflare.radar-get-http-top-ases-by-device-type Read
Get top ASes by HTTP requests for an HTTP protocol — cloudflare.radar-get-http-top-ases-by-http-protocol Read
Get top ASes by HTTP requests for an HTTP version — cloudflare.radar-get-http-top-ases-by-http-version Read
Get top ASes by HTTP requests for an IP version — cloudflare.radar-get-http-top-ases-by-ip-version Read
Get top ASes by HTTP requests for an OS — cloudflare.radar-get-http-top-ases-by-operating-system Read
Get top ASes by HTTP requests for a TLS version — cloudflare.radar-get-http-top-ases-by-tls-version Read
Get top locations by HTTP requests — cloudflare.radar-get-http-top-locations-by-http-requests Read
Get top locations by HTTP requests for a bot class — cloudflare.radar-get-http-top-locations-by-bot-class Read
Get top locations by HTTP requests for a browser family — cloudflare.radar-get-http-top-locations-by-browser-family Read
Get top locations by HTTP requests for a device type — cloudflare.radar-get-http-top-locations-by-device-type Read
Get top locations by HTTP requests for an HTTP protocol — cloudflare.radar-get-http-top-locations-by-http-protocol Read
Get top locations by HTTP requests for an HTTP version — cloudflare.radar-get-http-top-locations-by-http-version Read
Get top locations by HTTP requests for an IP version — cloudflare.radar-get-http-top-locations-by-ip-version Read
Get top locations by HTTP requests for an OS — cloudflare.radar-get-http-top-locations-by-operating-system Read
Get top locations by HTTP requests for a TLS version — cloudflare.radar-get-http-top-locations-by-tls-version Read
Get HTTP authentication requests distribution by dimension — cloudflare.radar-get-leaked-credential-checks-summary Read
Get time series distribution of HTTP authentication requests by dimension. — cloudflare.radar-get-leaked-credential-checks-timeseries-group Read
Get network traffic distribution by dimension — cloudflare.radar-get-netflows-summary Read
Get network traffic time series — cloudflare.radar-get-netflows-timeseries Read
Get time series distribution of network traffic by dimension — cloudflare.radar-get-netflows-timeseries-group Read
Get top ASes by network traffic — cloudflare.radar-get-netflows-top-ases Read
Get top locations by network traffic — cloudflare.radar-get-netflows-top-locations Read
List Origins — cloudflare.radar-get-origins Read
Get origin metrics distribution by dimension — cloudflare.radar-get-origins-summary Read
Get origin metrics time series — cloudflare.radar-get-origins-timeseries Read
Get origin metrics time series grouped by dimension — cloudflare.radar-get-origins-timeseries-group Read
Get Origin Post-Quantum Data Summary — cloudflare.radar-get-origin-post-quantum-summary Read
Get Origin Post-Quantum Data Over Time — cloudflare.radar-get-origin-post-quantum-timeseries-groups Read
Check Post-Quantum TLS support — cloudflare.radar-get-post-quantum-tls-support Read
Get speed tests histogram — cloudflare.radar-get-quality-speed-histogram Read
Get speed tests summary — cloudflare.radar-get-quality-speed-summary Read
Get top ASes by speed test results — cloudflare.radar-get-quality-speed-top-ases Read
Get top locations by speed test results — cloudflare.radar-get-quality-speed-top-locations Read
Get domain rank details — cloudflare.radar-get-ranking-domain-details Read
List Internet services categories — cloudflare.radar-get-ranking-internet-services-categories Read
Get Internet services rank time series — cloudflare.radar-get-ranking-internet-services-timeseries Read
Get top Internet services — cloudflare.radar-get-ranking-top-internet-services Read
Get domains rank time series — cloudflare.radar-get-ranking-domain-timeseries Read
Get top or trending domains — cloudflare.radar-get-ranking-top-domains Read
Get top domain categories by robots.txt files parsed — cloudflare.radar-get-robots-txt-top-domain-categories-by-files-parsed Read
Get top user agents on robots.txt files — cloudflare.radar-get-robots-txt-top-user-agents-by-directive Read
Search for locations, ASes, reports, and more — cloudflare.radar-get-search-global Read
Get TCP resets and timeouts summary — cloudflare.radar-get-tcp-resets-timeouts-summary Read
Get TCP resets and timeouts time series — cloudflare.radar-get-tcp-resets-timeouts-timeseries-group Read
List TLDs — cloudflare.radar-get-tlds Read
Get TLD Performance Summary — cloudflare.radar-get-tlds-performance-summary Read
Get TLD Performance Over Time — cloudflare.radar-get-tlds-performance-timeseries-groups Read
Get TLD details — cloudflare.radar-get-tld-details Read
Get latest Internet traffic anomalies — cloudflare.radar-get-traffic-anomalies Read
Get top locations by total traffic anomalies — cloudflare.radar-get-traffic-anomalies-top Read
Get traffic anomaly by UUID — cloudflare.radar-get-traffic-anomaly-by-uuid Read
List tenant accounts — cloudflare.tenants_listaccounts Read
List Tenant Custom Nameservers — cloudflare.tenant-level-custom-nameservers-list-tenant-custom-nameservers Read
Add Tenant Custom Nameserver — cloudflare.tenant-level-custom-nameservers-add-tenant-custom-nameserver Write
Delete Tenant Custom Nameserver — cloudflare.tenant-level-custom-nameservers-delete-tenant-custom-nameserver Write
User Details — cloudflare.user-user-details Read
Edit User — cloudflare.user-edit-user Write
Get count of zones with Argo Smart Routing enabled for user — cloudflare.argo-smart-routing-get-count-zones-enabled-for-user Read
Get user audit logs — cloudflare.audit-logs-get-user-audit-logs Read
Get communication preferences — cloudflare.user-communication-preferences-get Read
Update communication preferences — cloudflare.user-communication-preferences-update Write
List IP Access rules — cloudflare.ip-access-rules-for-a-user-list-ip-access-rules Read
Delete an IP Access rule — cloudflare.ip-access-rules-for-a-user-delete-an-ip-access-rule Write
Get an IP Access rule — cloudflare.ip-access-rules-for-a-user-get-an-ip-access-rule Read
Update an IP Access rule — cloudflare.ip-access-rules-for-a-user-update-an-ip-access-rule Write
List Invitations — cloudflare.user--s-invites-list-invitations Read
Invitation Details — cloudflare.user--s-invites-invitation-details Read
Respond to Invitation — cloudflare.user--s-invites-respond-to-invitation Write
List Monitors — cloudflare.load-balancer-monitors-list-monitors Read
Create Monitor — cloudflare.load-balancer-monitors-create-monitor Write
Delete Monitor — cloudflare.load-balancer-monitors-delete-monitor Write
Monitor Details — cloudflare.load-balancer-monitors-monitor-details Read
Patch Monitor — cloudflare.load-balancer-monitors-patch-monitor Write
Update Monitor — cloudflare.load-balancer-monitors-update-monitor Write
Preview Monitor — cloudflare.load-balancer-monitors-preview-monitor Write
List Monitor References — cloudflare.load-balancer-monitors-list-monitor-references Read
List Pools — cloudflare.load-balancer-pools-list-pools Read
Patch Pools — cloudflare.load-balancer-pools-patch-pools Write
Create Pool — cloudflare.load-balancer-pools-create-pool Write
Delete Pool — cloudflare.load-balancer-pools-delete-pool Write
Pool Details — cloudflare.load-balancer-pools-pool-details Read
Patch Pool — cloudflare.load-balancer-pools-patch-pool Write
Update Pool — cloudflare.load-balancer-pools-update-pool Write
Pool Health Details — cloudflare.load-balancer-pools-pool-health-details Read
Preview Pool — cloudflare.load-balancer-pools-preview-pool Write
List Pool References — cloudflare.load-balancer-pools-list-pool-references Read
Preview Result — cloudflare.load-balancer-monitors-preview-result Read
List Regions — cloudflare.user-load-balancer-regions-list-regions Read
List Healthcheck Events — cloudflare.load-balancer-healthcheck-events-list-healthcheck-events Read
Get User Membership — cloudflare.user-memberships-get Read
Get zones bandwidth report — cloudflare.spectrum-analytics-get-zones-report Read
Get User Subscriptions — cloudflare.user-subscription-get-user-subscriptions Read
Create User Subscription — cloudflare.user-subscription-create-user-subscription Write
Delete User Subscription — cloudflare.user-subscription-delete-user-subscription Write
Update User Subscription — cloudflare.user-subscription-update-user-subscription Write
List user tenants — cloudflare.user_listusertenants Read
List Tokens — cloudflare.user-api-tokens-list-tokens Read
Create Token — cloudflare.user-api-tokens-create-token Write
List Token Permission Groups — cloudflare.permission-groups-list-permission-groups Read
Verify Token — cloudflare.user-api-tokens-verify-token Read
Delete Token — cloudflare.user-api-tokens-delete-token Write
Token Details — cloudflare.user-api-tokens-token-details Read
Roll Token — cloudflare.user-api-tokens-roll-token Write
Request domain connect validation — cloudflare.postverify Write
Serve a provider template — cloudflare.getprovidertemplate Read
Serve a provider configuration — cloudflare.getproviderconfiguration Read
Provide settings if domain is served by Cloudflare — cloudflare.getdomainsettings Read
Trigger deploy hook — cloudflare.triggerdeployhook Write
List Zones — cloudflare.zones-get Read
Create Zone — cloudflare.zones-post Write
Delete Zone — cloudflare.zones-0-delete Write
Zone Details — cloudflare.zones-0-get Read
Edit Zone — cloudflare.zones-0-patch Write
List Access Applications — cloudflare.zone-level-access-applications-list-access-applications Read
Add an Access application — cloudflare.zone-level-access-applications-add-a-bookmark-application Write
List short-lived certificate CAs — cloudflare.zone-level-access-short-lived-certificate-c-as-list-short--22caea06d1 Read
Delete a short-lived certificate CA — cloudflare.zone-level-access-short-lived-certificate-c-as-delete-a-sh-a8831aa1dd Write
Get a short-lived certificate CA — cloudflare.zone-level-access-short-lived-certificate-c-as-get-a-short-eaf60afb56 Read
Create a short-lived certificate CA — cloudflare.zone-level-access-short-lived-certificate-c-as-create-a-sh-7a27acdb55 Write
List Access policies — cloudflare.zone-level-access-policies-list-access-policies Read
Create an Access policy — cloudflare.zone-level-access-policies-create-an-access-policy Write
Delete an Access policy — cloudflare.zone-level-access-policies-delete-an-access-policy Write
Get an Access policy — cloudflare.zone-level-access-policies-get-an-access-policy Read
Update an Access policy — cloudflare.zone-level-access-policies-update-an-access-policy Write
List mTLS certificates — cloudflare.zone-level-access-mtls-authentication-list-mtls-certificates Read
Add an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-add-an-mtls-certificate Write
List all mTLS hostname settings — cloudflare.zone-level-access-mtls-authentication-list-mtls-certificat-ae09802d86 Read
Update an mTLS certificate's hostname settings — cloudflare.zone-level-access-mtls-authentication-update-an-mtls-certi-9ab3745f97 Write
Delete an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-delete-an-mtls-certificate Write
Get an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-get-an-mtls-certificate Read
Update an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-update-an-mtls-certificate Write
List Access groups — cloudflare.zone-level-access-groups-list-access-groups Read
Create an Access group — cloudflare.zone-level-access-groups-create-an-access-group Write
Delete an Access group — cloudflare.zone-level-access-groups-delete-an-access-group Write
Get an Access group — cloudflare.zone-level-access-groups-get-an-access-group Read
Update an Access group — cloudflare.zone-level-access-groups-update-an-access-group Write
List Access identity providers — cloudflare.zone-level-access-identity-providers-list-access-identity-providers Read
Add an Access identity provider — cloudflare.zone-level-access-identity-providers-add-an-access-identity-provider Write
Delete an Access identity provider — cloudflare.zone-level-access-identity-providers-delete-an-access-iden-a86f257052 Write
Get an Access identity provider — cloudflare.zone-level-access-identity-providers-get-an-access-identity-provider Read
Update an Access identity provider — cloudflare.zone-level-access-identity-providers-update-an-access-iden-dc7a3c4e9e Write
Get your Zero Trust organization — cloudflare.zone-level-zero-trust-organization-get-your-zero-trust-organization Read
Create your Zero Trust organization — cloudflare.zone-level-zero-trust-organization-create-your-zero-trust--370c6afab3 Write
Update your Zero Trust organization — cloudflare.zone-level-zero-trust-organization-update-your-zero-trust--4e6f7216d2 Write
Revoke all Access tokens for a user — cloudflare.zone-level-zero-trust-organization-revoke-all-access-token-daef55cb0e Write
List service tokens — cloudflare.zone-level-access-service-tokens-list-service-tokens Read
Create a service token — cloudflare.zone-level-access-service-tokens-create-a-service-token Write
Delete a service token — cloudflare.zone-level-access-service-tokens-delete-a-service-token Write
Get a service token — cloudflare.zone-level-access-service-tokens-get-a-service-token Read
Update a service token — cloudflare.zone-level-access-service-tokens-update-a-service-token Write
List Custom Origin Trust Store Details — cloudflare.custom-origin-trust-store-list-details Read
Upload Custom Origin Trust Store — cloudflare.custom-origin-trust-store-create Write
Delete Custom Origin Trust Store — cloudflare.custom-origin-trust-store-delete Write
Custom Origin Trust Store Details — cloudflare.custom-origin-trust-store-details Read
Total TLS Settings Details — cloudflare.total-tls-total-tls-settings-details Read
Enable or Disable Total TLS — cloudflare.total-tls-enable-or-disable-total-tls Write
Rerun the Activation Check — cloudflare.put-zones-zone_id-activation_check Write
List Regional Hostnames — cloudflare.dls-zone-regional-hostnames-list Read
Create Regional Hostname — cloudflare.dls-zone-regional-hostnames-create Write
Delete Regional Hostname — cloudflare.dls-zone-regional-hostnames-delete Write
Fetch Regional Hostname — cloudflare.dls-zone-regional-hostnames-fetch Read
Update Regional Hostname — cloudflare.dls-zone-regional-hostnames-patch Write
Get robots.txt rules — cloudflare.ai-audit-get-robots Read
Bulk get robots.txt rules — cloudflare.ai-audit-bulk-get-robots Write
Get the AI Security for Apps custom topics of a zone. — cloudflare.ai-security-custom-topics-get Read
Update the AI Security for Apps custom topics of a zone. — cloudflare.ai-security-custom-topics-put Write
Get the AI Security for Apps status for a zone. — cloudflare.ai-security-settings-get Read
Update the AI Security for Apps status for a zone. — cloudflare.ai-security-settings-put Write
Argo Analytics for a zone — cloudflare.argo-analytics-for-zone-argo-analytics-for-a-zone Read
Argo Analytics for a zone at different PoPs — cloudflare.argo-analytics-for-geolocation-argo-analytics-for-a-zone-a-1002d24562 Read
Get session identifier settings — cloudflare.api-shield-settings-retrieve-information-about-specific-co-4672584b9d Read
Update session identifier settings — cloudflare.api-shield-settings-set-configuration-properties Write
Export discovered API operations as OpenAPI schemas — cloudflare.api-shield-api-discovery-retrieve-discovered-operations-on-da306fd4a9 Read
List discovered web and API operations — cloudflare.api-shield-api-discovery-retrieve-discovered-operations-on-a-zone Read
Edit discovered web and API operations — cloudflare.api-shield-api-patch-discovered-operations Write
Get a discovered web or API operation — cloudflare.api-shield-api-discovery-retrieve-discovered-operation-by-id Read
Edit a discovered web or API operation — cloudflare.api-shield-api-patch-discovered-operation Write
List operation labels — cloudflare.api-shield-labels-get-labels Read
Get a managed operation label — cloudflare.api-shield-labels-get-managed-label Read
Replace operations attached to a managed label — cloudflare.api-shield-labels-replace-operations-attached-to-managed-label Write
Delete user-defined operation labels — cloudflare.api-shield-labels-delete-user-labels Write
Create user-defined operation labels — cloudflare.api-shield-labels-create-user-labels Write
Delete a user-defined operation label — cloudflare.api-shield-delete-user-label Write
Get a user-defined operation label — cloudflare.api-shield-labels-get-user-label Read
Edit a user-defined operation label — cloudflare.api-shield-patch-user-label Write
Update a user-defined operation label — cloudflare.api-shield-put-user-label Write
Replace operations attached to a user-defined label — cloudflare.api-shield-labels-replace-operations-attached-to-user-label Write
Delete web or API operations — cloudflare.api-shield-endpoint-management-delete-multiple-operations Write
List web and API operations — cloudflare.api-shield-endpoint-management-retrieve-information-about--6722bf7447 Read
Create web or API operations — cloudflare.api-shield-endpoint-management-add-operations-to-a-zone Write
Create a web or API operation — cloudflare.api-shield-endpoint-management-add-operation-to-a-zone Write
Remove labels from web or API operations — cloudflare.api-shield-operations-bulk-delete-labels-to-operations Write
Attach labels to web or API operations — cloudflare.api-shield-operations-bulk-post-labels-to-operations Write
Replace labels on web or API operations — cloudflare.api-shield-operations-bulk-put-labels-to-operations Write
Delete a web or API operation — cloudflare.api-shield-endpoint-management-delete-an-operation Write
Get a web or API operation — cloudflare.api-shield-endpoint-management-retrieve-information-about--43cd9e45f3 Read
Remove labels from a web or API operation — cloudflare.api-shield-operations-delete-labels-from-operation Write
Attach labels to a web or API operation — cloudflare.api-shield-operations-post-labels-to-operation Write
Replace labels on a web or API operation — cloudflare.api-shield-operations-put-labels-to-operation Write
Export web and API operations as OpenAPI schemas — cloudflare.api-shield-endpoint-management-retrieve-operations-and-fea-7969eb7eff Read
Get Argo Smart Routing setting — cloudflare.argo-smart-routing-get-argo-smart-routing-setting Read
Patch Argo Smart Routing setting — cloudflare.argo-smart-routing-patch-argo-smart-routing-setting Write
Get Tiered Cache — cloudflare.tiered-caching-get-tiered-caching-setting Read
Update Tiered Cache — cloudflare.tiered-caching-patch-tiered-caching-setting Write
List Available Plans — cloudflare.zone-rate-plan-list-available-plans Read
Available Plan Details — cloudflare.zone-rate-plan-available-plan-details Read
List Available Rate Plans — cloudflare.zone-rate-plan-list-available-rate-plans Read
Get Zone Bot Management Config — cloudflare.bot-management-for-a-zone-get-config Read
List zone feedback reports — cloudflare.bot-management-zone-feedback-list Read
Submit a feedback report — cloudflare.bot-management-zone-feedback-create Write
Get Cache Reserve setting — cloudflare.zone-cache-settings-get-cache-reserve-setting Read
Change Cache Reserve setting — cloudflare.zone-cache-settings-change-cache-reserve-setting Write
Get Cache Reserve Clear — cloudflare.zone-cache-settings-get-cache-reserve-clear Read
Start Cache Reserve Clear — cloudflare.zone-cache-settings-start-cache-reserve-clear Write
Get Regional Tiered Cache setting — cloudflare.zone-cache-settings-get-regional-tiered-cache-setting Read
Change Regional Tiered Cache setting — cloudflare.zone-cache-settings-change-regional-tiered-cache-setting Write
Delete Smart Tiered Cache setting — cloudflare.smart-tiered-cache-delete-smart-tiered-cache-setting Write
Get Smart Tiered Cache setting — cloudflare.smart-tiered-cache-get-smart-tiered-cache-setting Read
Patch Smart Tiered Cache setting — cloudflare.smart-tiered-cache-patch-smart-tiered-cache-setting Write
Create Smart Tiered Cache setting — cloudflare.smart-tiered-cache-create-smart-tiered-cache-setting Write
Delete variants setting — cloudflare.zone-cache-settings-delete-variants-setting Write
Get variants setting — cloudflare.zone-cache-settings-get-variants-setting Read
Change variants setting — cloudflare.zone-cache-settings-change-variants-setting Write
List Hostname Associations — cloudflare.client-certificate-for-a-zone-list-hostname-associations Read
Replace Hostname Associations — cloudflare.client-certificate-for-a-zone-put-hostname-associations Write
List Client Certificates — cloudflare.client-certificate-for-a-zone-list-client-certificates Read
Create Client Certificate — cloudflare.client-certificate-for-a-zone-create-client-certificate Write
Revoke Client Certificate — cloudflare.client-certificate-for-a-zone-delete-client-certificate Write
Client Certificate Details — cloudflare.client-certificate-for-a-zone-client-certificate-details Read
Reactivate Client Certificate — cloudflare.client-certificate-for-a-zone-edit-client-certificate Write
Rules — cloudflare.zone-cloud-connector-rules Read
Put Rules — cloudflare.zone-cloud-conenctor-rules-put Write
Disable Content Scanning for a zone. — cloudflare.waf-content-scanning-disable Write
Enable Content Scanning for a zone. — cloudflare.waf-content-scanning-enable Write
List the Content Scanning custom expressions of a zone. — cloudflare.waf-content-scanning-list-custom-scan-expressions Read
Create Content Scanning custom expressions for a zone. — cloudflare.waf-content-scanning-add-custom-scan-expressions Write
Delete a Content Scanning custom expression from a zone. — cloudflare.waf-content-scanning-delete-custom-scan-expressions Write
Update a Content Scanning custom expression for a zone. — cloudflare.waf-content-scanning-update-custom-scan-expression Write
Get the Content Scanning status for a zone. — cloudflare.waf-content-scanning-get-status Read
Update the Content Scanning status for a zone. — cloudflare.waf-content-scanning-update-settings Write
Get CT Alerting Subscription — cloudflare.ct-alerting-get-subscription Read
Update CT Alerting Subscription — cloudflare.ct-alerting-update-subscription Write
List SSL Configurations — cloudflare.custom-ssl-for-a-zone-list-ssl-configurations Read
Create SSL Configuration — cloudflare.custom-ssl-for-a-zone-create-ssl-configuration Write
Re-prioritize SSL Certificates — cloudflare.custom-ssl-for-a-zone-re-prioritize-ssl-certificates Write
Delete SSL Configuration — cloudflare.custom-ssl-for-a-zone-delete-ssl-configuration Write
SSL Configuration Details — cloudflare.custom-ssl-for-a-zone-ssl-configuration-details Read
Edit SSL Configuration — cloudflare.custom-ssl-for-a-zone-edit-ssl-configuration Write
List Custom CSRs — cloudflare.custom-csrs-for-a-zone-list-custom-csrs Read
Create Custom CSR — cloudflare.custom-csrs-for-a-zone-create-custom-csr Write
Delete Custom CSR — cloudflare.custom-csrs-for-a-zone-delete-custom-csr Write
Custom CSR Details — cloudflare.custom-csrs-for-a-zone-custom-csr-details Read
List Custom Hostnames — cloudflare.custom-hostname-for-a-zone-list-custom-hostnames Read
Create Custom Hostname — cloudflare.custom-hostname-for-a-zone-create-custom-hostname Write
Delete Fallback Origin for Custom Hostnames — cloudflare.custom-hostname-fallback-origin-for-a-zone-delete-fallback-a74258cd43 Write
Get Fallback Origin for Custom Hostnames — cloudflare.custom-hostname-fallback-origin-for-a-zone-get-fallback-or-c9aa7aaff5 Read
Update Fallback Origin for Custom Hostnames — cloudflare.custom-hostname-fallback-origin-for-a-zone-update-fallback-3465fb829a Write
Get Custom Hostname Quota — cloudflare.custom-hostname-for-a-zone-get-custom-hostname-quota Read
Delete Custom Hostname (and any issued SSL certificates) — cloudflare.custom-hostname-for-a-zone-delete-custom-hostname---and-an-be27c53402 Write
Custom Hostname Details — cloudflare.custom-hostname-for-a-zone-custom-hostname-details Read
Edit Custom Hostname — cloudflare.custom-hostname-for-a-zone-edit-custom-hostname Write
Delete Single Certificate And Key For Custom Hostname — cloudflare.custom-hostname-for-a-zone-delete_single_certificate_and_k-57ef29945b Write
Replace Custom Certificate and Custom Key In Custom Hostname — cloudflare.custom-hostname-for-a-zone-edit-custom-certificate-custom-hostname Write
List custom pages — cloudflare.custom-pages-for-a-zone-list-custom-pages Read
List custom assets — cloudflare.custom-assets-for-a-zone-list-custom-assets Read
Create a custom asset — cloudflare.custom-assets-for-a-zone-create-a-custom-asset Write
Delete a custom asset — cloudflare.custom-assets-for-a-zone-delete-a-custom-asset Write
Get a custom asset — cloudflare.custom-assets-for-a-zone-get-a-custom-asset Read
Update a custom asset — cloudflare.custom-assets-for-a-zone-update-a-custom-asset Write
Create a preview token — cloudflare.custom-pages-for-a-zone-create-preview-token Write
Get a custom page — cloudflare.custom-pages-for-a-zone-get-a-custom-page Read
Update a custom page — cloudflare.custom-pages-for-a-zone-update-a-custom-page Write
Retrieve the DCV Delegation unique identifier. — cloudflare.dcv-delegation-uuid-get Read
Get device certificate provisioning status — cloudflare.devices-get-policy-certificates Read
Update device certificate provisioning status — cloudflare.devices-update-policy-certificates Write
List DNS Records — cloudflare.dns-records-for-a-zone-list-dns-records Read
Batch DNS Records — cloudflare.dns-records-for-a-zone-batch-dns-records Write
Export DNS Records — cloudflare.dns-records-for-a-zone-export-dns-records Read
List Scanned DNS Records — cloudflare.dns-records-for-a-zone-review-dns-scan Read
Review Scanned DNS Records — cloudflare.dns-records-for-a-zone-apply-dns-scan-results Write
Trigger DNS Record Scan — cloudflare.dns-records-for-a-zone-trigger-dns-scan Write
Get DNS Record Usage — cloudflare.dns-records-for-a-zone-get-usage Read
Delete DNS Record — cloudflare.dns-records-for-a-zone-delete-dns-record Write
DNS Record Details — cloudflare.dns-records-for-a-zone-dns-record-details Read
Show DNS Settings — cloudflare.dns-settings-for-a-zone-list-dns-settings Read
Update DNS Settings — cloudflare.dns-settings-for-a-zone-update-dns-settings Write
Delete DNSSEC records — cloudflare.dnssec-delete-dnssec-records Write
DNSSEC Details — cloudflare.dnssec-dnssec-details Read
Edit DNSSEC Status — cloudflare.dnssec-edit-dnssec-status Write
List DNSSEC ZSKs — cloudflare.dnssec-list-dnssec-zsks Read
Get DMARC Report Status — cloudflare.get_dmarc_reports_status Read
Configure DMARC Reports — cloudflare.configure_dmarc_reports Write
Inspect SPF Record — cloudflare.inspect_spf Read
Get Email Routing settings — cloudflare.email-routing-settings-get-email-routing-settings Read
Update Email Routing settings — cloudflare.email-routing-settings-update-email-routing-settings Write
Apply Email Routing settings — cloudflare.email-routing-settings-replace-email-routing-settings Write
Disable Email Routing — cloudflare.email-routing-settings-disable-email-routing-dns Write
Email Routing - DNS settings — cloudflare.email-routing-settings-email-routing-dns-settings Read
Unlock Email Routing DNS records — cloudflare.email-routing-settings-unlock-email-routing-dns Write
Enable Email Routing — cloudflare.email-routing-settings-enable-email-routing-dns Write
List routing rules — cloudflare.email-routing-routing-rules-list-routing-rules Read
Create routing rule — cloudflare.email-routing-routing-rules-create-routing-rule Write
Get catch-all rule — cloudflare.email-routing-routing-rules-get-catch-all-rule Read
Update catch-all rule — cloudflare.email-routing-routing-rules-update-catch-all-rule Write
Delete routing rule — cloudflare.email-routing-routing-rules-delete-routing-rule Write
Get routing rule — cloudflare.email-routing-routing-rules-get-routing-rule Read
Update routing rule — cloudflare.email-routing-routing-rules-update-routing-rule Write
List sending subdomains — cloudflare.email-sending-subdomains-list-sending-subdomains Read
Create a sending subdomain — cloudflare.email-sending-subdomains-create-sending-subdomain Write
Preview sending subdomain DNS — cloudflare.email-sending-subdomains-preview-sending-subdomain Write
Delete a sending subdomain — cloudflare.email-sending-subdomains-delete-sending-subdomain Write
Get a sending subdomain — cloudflare.email-sending-subdomains-get-sending-subdomain Read
Update a sending subdomain — cloudflare.email-sending-subdomains-update-sending-subdomain Write
Get sending subdomain DNS records — cloudflare.email-sending-subdomains-get-sending-subdomain-dns Read
Fix sending subdomain DNS records — cloudflare.email-sending-subdomains-fix-sending-subdomain-dns Write
Get sending subdomain DNS status — cloudflare.email-sending-subdomains-get-sending-subdomain-dns-status Read
Get sending subdomain complaint count — cloudflare.email-sending-subdomains-get-sending-subdomain-reputation-complaints Read
Get Zone Entitlements — cloudflare.entitlements-get-zone-entitlements Read
List zone environments — cloudflare.zonesenvironmentslist Read
Partially update zone environments — cloudflare.zonesenvironmentsedit Write
Create zone environments — cloudflare.zonesenvironmentscreate Write
Upsert zone environments — cloudflare.zonesenvironmentsupdate Write
Delete zone environment — cloudflare.zonesenvironmentsdelete Write
Invalidate Cached Content by Environment — cloudflare.zone-environment-invalidate Write
Purge Cached Content by Environment — cloudflare.zone-environment-purge Write
Roll back zone environment — cloudflare.zonesenvironmentsrollback Write
List IP Access rules — cloudflare.ip-access-rules-for-a-zone-list-ip-access-rules Read
Delete an IP Access rule — cloudflare.ip-access-rules-for-a-zone-delete-an-ip-access-rule Write
Update an IP Access rule — cloudflare.ip-access-rules-for-a-zone-update-an-ip-access-rule Write
List Zone Lockdown rules — cloudflare.zone-lockdown-list-zone-lockdown-rules Read
Create a Zone Lockdown rule — cloudflare.zone-lockdown-create-a-zone-lockdown-rule Write
Delete a Zone Lockdown rule — cloudflare.zone-lockdown-delete-a-zone-lockdown-rule Write
Get a Zone Lockdown rule — cloudflare.zone-lockdown-get-a-zone-lockdown-rule Read
Update a Zone Lockdown rule — cloudflare.zone-lockdown-update-a-zone-lockdown-rule Write
Delete the payload logging key — cloudflare.payload-logging-keys-for-a-zone-delete-the-payload-logging-key Write
Get the payload logging key — cloudflare.payload-logging-keys-for-a-zone-get-the-payload-logging-key Read
Set the payload logging key — cloudflare.payload-logging-keys-for-a-zone-set-the-payload-logging-key Write
List User Agent Blocking rules — cloudflare.user-agent-blocking-rules-list-user-agent-blocking-rules Read
Create a User Agent Blocking rule — cloudflare.user-agent-blocking-rules-create-a-user-agent-blocking-rule Write
Delete a User Agent Blocking rule — cloudflare.user-agent-blocking-rules-delete-a-user-agent-blocking-rule Write
Get a User Agent Blocking rule — cloudflare.user-agent-blocking-rules-get-a-user-agent-blocking-rule Read
Get Fraud Detection Settings — cloudflare.fraud-detection-zone-get-settings Read
Update Fraud Detection Settings — cloudflare.fraud-detection-zone-update-settings Write
List Health Checks — cloudflare.health-checks-list-health-checks Read
Create Health Check — cloudflare.health-checks-create-health-check Write
Create Preview Health Check — cloudflare.health-checks-create-preview-health-check Write
Delete Preview Health Check — cloudflare.health-checks-delete-preview-health-check Write
Health Check Preview Details — cloudflare.health-checks-health-check-preview-details Read
Delete Health Check — cloudflare.health-checks-delete-health-check Write
Health Check Details — cloudflare.health-checks-health-check-details Read
Patch Health Check — cloudflare.health-checks-patch-health-check Write
Update Health Check — cloudflare.health-checks-update-health-check Write
Remove Zone Hold — cloudflare.zones-0-hold-delete Write
Get Zone Hold — cloudflare.zones-0-hold-get Read
Update Zone Hold — cloudflare.zones-0-hold-patch Write
Create Zone Hold — cloudflare.zones-0-hold-post Write
List TLS setting for hostnames — cloudflare.per-hostname-tls-settings-list Read
Delete TLS setting for hostname — cloudflare.per-hostname-tls-settings-delete Write
Get TLS setting for hostname — cloudflare.per-hostname-tls-settings-get Read
Edit TLS setting for hostname — cloudflare.per-hostname-tls-settings-put Write
Get transformation flows — cloudflare.get_flowsget Read
Update transformation flows — cloudflare.put_flowsupdate Write
Create an ingress rule — cloudflare.sinkhole-config-create-ingress Write
Delete an ingress rule — cloudflare.sinkhole-config-delete-ingress Write
Get an ingress rule — cloudflare.sinkhole-config-get-ingress Read
Update an ingress rule — cloudflare.sinkhole-config-update-ingress Write
Invalidate Cached Content — cloudflare.zone-invalidate Write
List Keyless SSL Configurations — cloudflare.keyless-ssl-for-a-zone-list-keyless-ssl-configurations Read
Create Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-create-keyless-ssl-configuration Write
Delete Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-delete-keyless-ssl-configuration Write
Get Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-get-keyless-ssl-configuration Read
Edit Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-edit-keyless-ssl-configuration Write
Get the Leaked Credential Checks status for a zone. — cloudflare.waf-product-api-leaked-credentials-get-status Read
Update the Leaked Credential Checks status for a zone. — cloudflare.waf-product-api-leaked-credentials-set-status Write
List the custom detection locations of a zone. — cloudflare.waf-product-api-leaked-credentials-list-detections Read
Create a custom detection location for a zone. — cloudflare.waf-product-api-leaked-credentials-create-detection Write
Delete a custom detection location from a zone. — cloudflare.waf-product-api-leaked-credentials-delete-detection Write
Get a custom detection location of a zone. — cloudflare.waf-product-api-leaked-credentials-get-detection Read
Update a custom detection location of a zone. — cloudflare.waf-product-api-leaked-credentials-update-detection Write
List Load Balancers — cloudflare.load-balancers-list-load-balancers Read
Create Load Balancer — cloudflare.load-balancers-create-load-balancer Write
Delete Load Balancer — cloudflare.load-balancers-delete-load-balancer Write
Load Balancer Details — cloudflare.load-balancers-load-balancer-details Read
Patch Load Balancer — cloudflare.load-balancers-patch-load-balancer Write
Update Load Balancer — cloudflare.load-balancers-update-load-balancer Write
List fields — cloudflare.get-zones-zone_id-logpush-datasets-dataset_id-fields Read
List Logpush jobs for a dataset — cloudflare.get-zones-zone_id-logpush-datasets-dataset_id-jobs Read
List Instant Logs jobs — cloudflare.get-zones-zone_id-logpush-edge-jobs Read
Create Instant Logs job — cloudflare.post-zones-zone_id-logpush-edge-jobs Write
List Logpush jobs — cloudflare.get-zones-zone_id-logpush-jobs Read
Create Logpush job — cloudflare.post-zones-zone_id-logpush-jobs Write
Delete Logpush job — cloudflare.delete-zones-zone_id-logpush-jobs-job_id Write
Get Logpush job details — cloudflare.get-zones-zone_id-logpush-jobs-job_id Read
Update Logpush job — cloudflare.put-zones-zone_id-logpush-jobs-job_id Write
Get ownership challenge — cloudflare.post-zones-zone_id-logpush-ownership Write
Validate ownership challenge — cloudflare.post-zones-zone_id-logpush-ownership-validate Write
Validate destination — cloudflare.post-zones-zone_id-logpush-validate-destination Write
Check destination exists — cloudflare.post-zones-zone_id-logpush-validate-destination-exists Write
Validate origin — cloudflare.post-zones-zone_id-logpush-validate-origin Write
Get log retention flag — cloudflare.get-zones-zone_id-logs-control-retention-flag Read
Update log retention flag — cloudflare.post-zones-zone_id-logs-control-retention-flag Write
Get logs RayIDs — cloudflare.get-zones-zone_id-logs-rayids-ray_id Read
Get logs received — cloudflare.get-zones-zone_id-logs-received Read
List fields — cloudflare.get-zones-zone_id-logs-received-fields Read
Delete Managed Transforms — cloudflare.deletemanagedtransforms Write
List Managed Transforms — cloudflare.listmanagedtransforms Read
Update Managed Transforms — cloudflare.updatemanagedtransforms Write
Get zone Media usage — cloudflare.usage-analytics-get-zone-media-usage Read
Get zone monetization eligibility — cloudflare.monetization-get-zone-eligibility Read
Check zone monetization eligibility — cloudflare.monetization-check-zone-eligibility Write
Delete all payment rules — cloudflare.monetization-delete-ruleset Write
List payment rules — cloudflare.monetization-list-rules Read
Deploy payment ruleset — cloudflare.monetization-deploy-ruleset Write
Delete a payment rule — cloudflare.monetization-delete-rule Write
Get a payment rule — cloudflare.monetization-get-rule Read
Update a payment rule — cloudflare.monetization-patch-rule Write
Delete zone trace rules — cloudflare.zone.observability.tracing.rules.delete Write
View zone trace rules — cloudflare.zone.observability.tracing.rules.get Read
Replace zone trace rules — cloudflare.zone.observability.tracing.rules.update Write
Reset zone tracing settings — cloudflare.zone.observability.tracing.settings.delete Write
View zone tracing settings — cloudflare.zone.observability.tracing.settings.get Read
List origin cloud region mappings — cloudflare.origin-cloud-regions-v2-list Read
Batch delete origin cloud region mappings — cloudflare.origin-cloud-regions-v2-batch-delete Write
Batch create or replace origin cloud region mappings — cloudflare.origin-cloud-regions-v2-batch-upsert Write
List supported cloud vendors and regions — cloudflare.origin-cloud-regions-v2-supported-regions Read
Delete an origin cloud region mapping — cloudflare.origin-cloud-regions-v2-delete Write
Get an origin cloud region mapping — cloudflare.origin-cloud-regions-v2-get Read
Create or replace an origin cloud region mapping — cloudflare.origin-cloud-regions-v2-upsert Write
List Certificates — cloudflare.zone-level-authenticated-origin-pulls-list-certificates Read
Upload Certificate — cloudflare.zone-level-authenticated-origin-pulls-upload-certificate Write
List Hostname Associations — cloudflare.per-hostname-authenticated-origin-pull-list-hostname-associations Read
Enable or Disable a Hostname for Client Authentication — cloudflare.per-hostname-authenticated-origin-pull-enable-or-disable-a-9a86acfd38 Write
List Certificates — cloudflare.per-hostname-authenticated-origin-pull-list-certificates Read
Upload a Hostname Client Certificate — cloudflare.per-hostname-authenticated-origin-pull-upload-a-hostname-c-0fd8e52701 Write
Delete Hostname Client Certificate — cloudflare.per-hostname-authenticated-origin-pull-delete-hostname-cli-22f3b7c122 Write
Get the Hostname Client Certificate — cloudflare.per-hostname-authenticated-origin-pull-get-the-hostname-cl-9a143608ca Read
Get the Hostname Status for Client Authentication — cloudflare.per-hostname-authenticated-origin-pull-get-the-hostname-st-5bc83da3fe Read
Get Enablement Setting for Zone — cloudflare.zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone Read
Set Enablement for Zone — cloudflare.zone-level-authenticated-origin-pulls-set-enablement-for-zone Write
Delete Certificate — cloudflare.zone-level-authenticated-origin-pulls-delete-certificate Write
Get Certificate Details — cloudflare.zone-level-authenticated-origin-pulls-get-certificate-details Read
Get client-side security settings — cloudflare.page-shield-get-settings Read
Update client-side security settings — cloudflare.page-shield-update-settings Write
List detected connections — cloudflare.page-shield-list-connections Read
Get a detected connection — cloudflare.page-shield-get-connection Read
List detected cookies — cloudflare.page-shield-list-cookies Read
Get a detected cookie — cloudflare.page-shield-get-cookie Read
List content security rules — cloudflare.page-shield-list-policies Read
Create a content security rule — cloudflare.page-shield-create-policy Write
Delete a content security rule — cloudflare.page-shield-delete-policy Write
Get a content security rule — cloudflare.page-shield-get-policy Read
Update a content security rule — cloudflare.page-shield-update-policy Write
List detected scripts — cloudflare.page-shield-list-scripts Read
Get a detected script — cloudflare.page-shield-get-script Read
List Page Rules — cloudflare.page-rules-list-page-rules Read
Create a Page Rule — cloudflare.page-rules-create-a-page-rule Write
Delete a Page Rule — cloudflare.page-rules-delete-a-page-rule Write
Get a Page Rule — cloudflare.page-rules-get-a-page-rule Read
Edit a Page Rule — cloudflare.page-rules-edit-a-page-rule Write
Update a Page Rule — cloudflare.page-rules-update-a-page-rule Write
Get pay-per-crawl zone eligibility — cloudflare.pay-per-crawl.getzonecanbeenabled Read
Get the pay-per-crawl config — cloudflare.pay-per-crawl.getconfig Read
Changes pay-per-crawl config for a zone — cloudflare.pay-per-crawl.patchconfig Write
Get pay-per-use zone eligibility — cloudflare.pay-per-crawl.getppuzonecanbeenabled Read
Get pay-per-use zone configuration — cloudflare.pay-per-crawl.getppuzoneconfiguration Read
Update pay-per-use zone configuration — cloudflare.pay-per-crawl.patchppuzoneconfiguration Write
List pay-per-use operators — cloudflare.pay-per-crawl.listppuoperators Read
Get pay-per-use usage statistics for a zone — cloudflare.pay-per-crawl.getppuzoneusagestats Read
Get Zone Precursor Config — cloudflare.precursor-for-a-zone-get-config Read
Update Zone Precursor Config — cloudflare.precursor-for-a-zone-update-config Write
Purge Cached Content — cloudflare.zone-purge Write
List zone rulesets — cloudflare.listzonerulesets Read
Create a zone ruleset — cloudflare.createzoneruleset Write
Get a zone entry point ruleset — cloudflare.getzoneentrypointruleset Read
Update a zone entry point ruleset — cloudflare.updatezoneentrypointruleset Write
List a zone entry point ruleset's versions — cloudflare.listzoneentrypointrulesetversions Read
Get a zone entry point ruleset version — cloudflare.getzoneentrypointrulesetversion Read
Delete a zone ruleset — cloudflare.deletezoneruleset Write
Get a zone ruleset — cloudflare.getzoneruleset Read
Update a zone ruleset — cloudflare.updatezoneruleset Write
Delete a zone ruleset rule — cloudflare.deletezonerulesetrule Write
List a zone ruleset's versions — cloudflare.listzonerulesetversions Read
Delete a zone ruleset version — cloudflare.deletezonerulesetversion Write
Get a zone ruleset version — cloudflare.getzonerulesetversion Read
List a zone ruleset version's rules by tag — cloudflare.listzonerulesetversionrulesbytag Read
List all uploaded schemas — cloudflare.schema-validation-list-schemas-paginated Read
Upload a schema — cloudflare.schema-validation-create-schema Write
List hosts covered by uploaded schemas — cloudflare.schema-validation-list-schema-hosts Read
Get global schema validation settings — cloudflare.schema-validation-get-settings Read
Edit global schema validation settings — cloudflare.schema-validation-edit-settings Write
List per-operation schema validation settings — cloudflare.schema-validation-list-per-operation-settings Read
Bulk edit per-operation schema validation settings — cloudflare.schema-validation-bulk-edit-per-operation-settings Write
Delete per-operation schema validation setting — cloudflare.schema-validation-delete-per-operation-setting Write
Get per-operation schema validation setting — cloudflare.schema-validation-get-per-operation-setting Read
Force AXFR — cloudflare.secondary-dns---secondary-zone--force-axfr Write
Delete Secondary Zone Configuration — cloudflare.secondary-dns---secondary-zone--delete-secondary-zone-configuration Write
Secondary Zone Configuration Details — cloudflare.secondary-dns---secondary-zone--secondary-zone-configuration-details Read
Create Secondary Zone Configuration — cloudflare.secondary-dns---secondary-zone--create-secondary-zone-configuration Write
Update Secondary Zone Configuration — cloudflare.secondary-dns---secondary-zone--update-secondary-zone-configuration Write
Delete Primary Zone Configuration — cloudflare.secondary-dns---primary-zone--delete-primary-zone-configuration Write
Primary Zone Configuration Details — cloudflare.secondary-dns---primary-zone--primary-zone-configuration-details Read
Create Primary Zone Configuration — cloudflare.secondary-dns---primary-zone--create-primary-zone-configuration Write
Update Primary Zone Configuration — cloudflare.secondary-dns---primary-zone--update-primary-zone-configuration Write
Disable Outgoing Zone Transfers — cloudflare.secondary-dns---primary-zone--disable-outgoing-zone-transfers Write
Enable Outgoing Zone Transfers — cloudflare.secondary-dns---primary-zone--enable-outgoing-zone-transfers Write
Force DNS NOTIFY — cloudflare.secondary-dns---primary-zone--force-dns-notify Write
Get Outgoing Zone Transfer Status — cloudflare.secondary-dns---primary-zone--get-outgoing-zone-transfer-status Read
Retrieves Zone Security Center Insights — cloudflare.get-zone-security-center-insights Read
Retrieves Zone Audit Log — cloudflare.get-zone-security-center-audit-log Read
Retrieves Zone Security Center Insight Counts by Class — cloudflare.get-zone-security-center-insight-counts-by-class Read
Retrieves a Partner Zone Security Center Insight Count — cloudflare.get-zone-security-center-partner-insight-count Read
Get Recent Zone Scans — cloudflare.get-security-center-zone-scans Read
Start On-Demand Zone Scan — cloudflare.start-security-center-zone-scan Write
Retrieves Zone Security Center Insight Counts by Severity — cloudflare.get-zone-security-center-insight-counts-by-severity Read
Retrieves Zone Security Center Insight Counts by Type — cloudflare.get-zone-security-center-insight-counts-by-type Read
Retrieves Zone Issue Audit Log — cloudflare.get-zone-security-center-issue-audit-log Read
Updates Zone Security Center Insight Classification — cloudflare.update-zone-security-center-insight-classification Write
Archives Zone Security Center Insight — cloudflare.archive-zone-security-center-insight Write
Lists Partner-Discovered Shadow Hosts for a Zone — cloudflare.get-zone-security-center-partner-shadow-hosts Read
Deletes security.txt — cloudflare.delete-security-txt Write
Retrieves security.txt — cloudflare.get-security-txt Read
Updates security.txt — cloudflare.update-security-txt Write
Delete aegis setting — cloudflare.zone-cache-settings-delete-aegis-setting Write
Get aegis setting — cloudflare.zone-cache-settings-get-aegis-setting Read
Change aegis setting — cloudflare.zone-cache-settings-change-aegis-setting Write
Get Auto-Origin TLS KEX enrollment status for the given zone — cloudflare.ssl-detector-auto-origin-tls-kex-get-enrollment Read
Patch Auto-Origin TLS KEX enrollment status for the given zone — cloudflare.ssl-detector-auto-origin-tls-kex-patch-enrollment Write
Get Automatic Platform Optimization setting — cloudflare.zone-settings-get-automatic-platform-optimization-setting Read
Change Automatic Platform Optimization setting — cloudflare.zone-settings-change-automatic-platform-optimization-setting Write
Get Binary AST setting — cloudflare.zone-settings-get-binary-ast-setting Read
Change Binary AST setting — cloudflare.zone-settings-change-binary-ast-setting Write
Get CSAM Scanner setting — cloudflare.csam-scanner-get-setting Read
Update CSAM Scanner setting — cloudflare.csam-scanner-update-setting Write
Get Cloudflare Fonts setting — cloudflare.zone-settings-get-fonts-setting Read
Change Cloudflare Fonts setting — cloudflare.zone-settings-change-fonts-setting Write
Get Google Tag Gateway configuration — cloudflare.zone-settings-get-google-tag-gateway-config Read
Update Google Tag Gateway configuration — cloudflare.zone-settings-change-google-tag-gateway-config Write
Get HTTP/2 Prioritization setting — cloudflare.zone-settings-get-h2-prioritization-setting Read
Change HTTP/2 Prioritization setting — cloudflare.zone-settings-change-h2-prioritization-setting Write
Get Image Transformations setting — cloudflare.zone-settings-get-image-resizing-setting Read
Change Image Transformations setting — cloudflare.zone-settings-change-image-resizing-setting Write
Get NEL setting — cloudflare.nel-settings-get Read
Edit NEL setting — cloudflare.nel-settings-edit Write
Get Origin H2 Max Streams Setting — cloudflare.zone-cache-settings-get-origin-h2-max-streams-setting Read
Change Origin H2 Max Streams Setting — cloudflare.zone-cache-settings-change-origin-h2-max-streams-setting Write
Get Origin Max HTTP Version Setting — cloudflare.zone-cache-settings-get-origin-max-http-version-setting Read
Change Origin Max HTTP Version Setting — cloudflare.zone-cache-settings-change-origin-max-http-version-setting Write
Delete Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-delete-origin-tls-compliance-modes-setting Write
Get Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-get-origin-tls-compliance-modes-setting Read
Change Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-change-origin-tls-compliance-modes-setting Write
Replace Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-replace-origin-tls-compliance-modes-setting Write
Get RUM status for a zone — cloudflare.web-analytics-get-rum-status Read
Toggle RUM on/off for a zone — cloudflare.web-analytics-toggle-rum Write
Get Cloudflare Speed Brain setting — cloudflare.zone-settings-get-speed-brain-setting Read
Change Cloudflare Speed Brain setting — cloudflare.zone-settings-change-speed-brain-setting Write
Get Automatic SSL/TLS enrollment status for the given zone — cloudflare.ssl-detector-automatic-mode-get-enrollment Read
Patch Automatic SSL/TLS Enrollment status for given zone — cloudflare.ssl-detector-automatic-mode-patch-enrollment Write
Get Image Transformations Allowed Origins setting — cloudflare.zone-settings-get-transformations-allowed-origins-setting Read
Change Image Transformations Allowed Origins setting — cloudflare.zone-settings-change-transformations-allowed-origins-setting Write
Get Image Transformations C2PA setting — cloudflare.zone-settings-get-transformations-c2pa-setting Read
Change Image Transformations C2PA setting — cloudflare.zone-settings-change-transformations-c2pa-setting Write
Get Transformations configuration — cloudflare.zone-settings-get-transformations-config Read
Change Transformations configuration — cloudflare.zone-settings-change-transformations-config Write
Get Zaraz configuration — cloudflare.get-zones-zone_identifier-zaraz-config Read
Get default Zaraz configuration — cloudflare.get-zones-zone_identifier-zaraz-default Read
Export Zaraz configuration — cloudflare.get-zones-zone_identifier-zaraz-export Read
List Zaraz historical configuration records — cloudflare.get-zones-zone_identifier-zaraz-history Read
Restore Zaraz historical configuration by ID — cloudflare.put-zones-zone_identifier-zaraz-history Write
Get Zaraz historical configurations by ID(s) — cloudflare.get-zones-zone_identifier-zaraz-config-history Read
Publish Zaraz preview configuration — cloudflare.post-zones-zone_identifier-zaraz-publish Write
Get Zaraz workflow — cloudflare.get-zones-zone_identifier-zaraz-workflow Read
Update Zaraz workflow — cloudflare.put-zones-zone_identifier-zaraz-workflow Write
Get zone setting — cloudflare.zone-settings-get-single-setting Read
Get Smart Shield Settings — cloudflare.smart-shield-get-settings Read
Patch Smart Shield Settings — cloudflare.smart-shield-patch-settings Write
Get Cache Reserve Clear — cloudflare.smart-shield-settings-get-cache-reserve-clear Read
Start Cache Reserve Clear — cloudflare.smart-shield-settings-start-cache-reserve-clear Write
List Health Checks — cloudflare.smart-shield-list-health-checks Read
Create Health Check — cloudflare.smart-shield-create-health-check Write
Delete Health Check — cloudflare.smart-shield-delete-health-check Write
Health Check Details — cloudflare.smart-shield-health-check-details Read
Patch Health Check — cloudflare.smart-shield-patch-health-check Write
Update Health Check — cloudflare.smart-shield-update-health-check Write
List zone snippets — cloudflare.listzonesnippets Read
Delete zone snippet rules — cloudflare.deletezonesnippetrules Write
List zone snippet rules — cloudflare.listzonesnippetrules Read
Update zone snippet rules — cloudflare.updatezonesnippetrules Write
Delete a zone snippet — cloudflare.deletezonesnippet Write
Get a zone snippet — cloudflare.getzonesnippet Read
Get current aggregated analytics — cloudflare.spectrum-aggregate-analytics-get-current-aggregated-analytics Read
Get analytics by time — cloudflare.spectrum-analytics---by-time--get-analytics-by-time Read
Get analytics summary — cloudflare.spectrum-analytics---summary--get-analytics-summary Read
List Spectrum applications — cloudflare.spectrum-applications-list-spectrum-applications Read
Delete Spectrum application — cloudflare.spectrum-applications-delete-spectrum-application Write
Get Spectrum application configuration — cloudflare.spectrum-applications-get-spectrum-application-configuration Read
List Spectrum application protocols — cloudflare.spectrum-applications-list-spectrum-application-protocols Read
Get quota and availability — cloudflare.speed-get-availabilities Read
List tested webpages — cloudflare.speed-list-pages Read
Delete all page tests — cloudflare.speed-delete-tests Write
List page test history — cloudflare.speed-list-test-history Read
Start page test — cloudflare.speed-create-test Write
Get a page test result — cloudflare.speed-get-test Read
List core web vital metrics trend — cloudflare.speed-list-page-trend Read
Delete scheduled page test — cloudflare.speed-delete-test-schedule Write
Get a page test schedule — cloudflare.speed-get-scheduled-test Read
Create scheduled page test — cloudflare.speed-create-scheduled-test Write
Analyze Certificate — cloudflare.analyze-certificate-analyze-certificate Write
List Certificate Packs — cloudflare.certificate-packs-list-certificate-packs Read
Order Advanced Certificate Manager Certificate Pack — cloudflare.certificate-packs-order-advanced-certificate-manager-certificate-pack Write
Get Certificate Pack Quotas — cloudflare.certificate-packs-get-certificate-pack-quotas Read
Delete Advanced Certificate Manager Certificate Pack — cloudflare.certificate-packs-delete-advanced-certificate-manager-cert-c1b2665810 Write
Get Certificate Pack — cloudflare.certificate-packs-get-certificate-pack Read
Restart Validation or Update Advanced Certificate Manager Certificate Pack — cloudflare.certificate-packs-restart-validation-for-advanced-certific-b3c0a565ac Write
Universal SSL Settings Details — cloudflare.universal-ssl-settings-for-a-zone-universal-ssl-settings-details Read
Edit Universal SSL Settings — cloudflare.universal-ssl-settings-for-a-zone-edit-universal-ssl-settings Write
SSL Verification Details — cloudflare.ssl-verification-ssl-verification-details Read
Edit SSL Certificate Pack Validation Method — cloudflare.ssl-verification-edit-ssl-certificate-pack-validation-method Write
Get zone Stream usage — cloudflare.usage-analytics-get-zone-stream-usage Read
Delete Zone Subscription — cloudflare.zone-subscription-delete-zone-subscription Write
Zone Subscription Details — cloudflare.zone-subscription-zone-subscription-details Read
Create Zone Subscription — cloudflare.zone-subscription-create-zone-subscription Write
Update Zone Subscription — cloudflare.zone-subscription-update-zone-subscription Write
Delete Zone Subscription — cloudflare.zone-subscription-delete-zone-subscriptions Write
Create Zone Subscription — cloudflare.zone-subscription-create-zone-subscriptions Write
Update Zone Subscription — cloudflare.zone-subscription-update-zone-subscriptions Write
Delete tags from a zone-level resource — cloudflare.tags-zone-delete Write
Get tags for a zone-level resource — cloudflare.tags-zone-get Read
Set tags for a zone-level resource — cloudflare.tags-zone-set Write
List token validation configurations — cloudflare.token-validation-config-list Read
Create a token validation configuration — cloudflare.token-validation-config-create Write
Delete a token validation configuration — cloudflare.token-validation-config-delete Write
Get a token validation configuration — cloudflare.token-validation-config-get Read
Edit a token validation configuration — cloudflare.token-validation-config-edit Write
Edit token validation credentials — cloudflare.token-validation-config-credentials-edit Write
Replace token validation credentials — cloudflare.token-validation-config-credentials-update Write
List token validation rules — cloudflare.token-validation-rules-list Read
Edit token validation rules — cloudflare.token-validation-rules-bulk-edit Write
Create token validation rules — cloudflare.token-validation-rules-bulk-create Write
Preview a token validation rule — cloudflare.token-validation-rules-preview Write
Delete a token validation rule — cloudflare.token-validation-rules-delete Write
Get a token validation rule — cloudflare.token-validation-rules-get Read
Edit a token validation rule — cloudflare.token-validation-rules-edit Write
Delete URL Normalization settings — cloudflare.deleteurlnormalization Write
Get URL Normalization settings — cloudflare.geturlnormalization Read
Update URL Normalization settings — cloudflare.updateurlnormalization Write
List waiting rooms for zone — cloudflare.waiting-room-list-waiting-rooms Read
Create waiting room — cloudflare.waiting-room-create-waiting-room Write
Create a custom waiting room page preview — cloudflare.waiting-room-create-a-custom-waiting-room-page-preview Write
Get zone-level Waiting Room settings — cloudflare.waiting-room-get-zone-settings Read
Patch zone-level Waiting Room settings — cloudflare.waiting-room-patch-zone-settings Write
Update zone-level Waiting Room settings — cloudflare.waiting-room-update-zone-settings Write
Delete waiting room — cloudflare.waiting-room-delete-waiting-room Write
Waiting room details — cloudflare.waiting-room-waiting-room-details Read
Patch waiting room — cloudflare.waiting-room-patch-waiting-room Write
Update waiting room — cloudflare.waiting-room-update-waiting-room Write
List events — cloudflare.waiting-room-list-events Read
Create event — cloudflare.waiting-room-create-event Write
Delete event — cloudflare.waiting-room-delete-event Write
Event details — cloudflare.waiting-room-event-details Read
Patch event — cloudflare.waiting-room-patch-event Write
Update event — cloudflare.waiting-room-update-event Write
Preview active event details — cloudflare.waiting-room-preview-active-event-details Read
List Waiting Room Rules — cloudflare.waiting-room-list-waiting-room-rules Read
Create Waiting Room Rule — cloudflare.waiting-room-create-waiting-room-rule Write
Replace Waiting Room Rules — cloudflare.waiting-room-replace-waiting-room-rules Write
Delete Waiting Room Rule — cloudflare.waiting-room-delete-waiting-room-rule Write
Patch Waiting Room Rule — cloudflare.waiting-room-patch-waiting-room-rule Write
Get waiting room status — cloudflare.waiting-room-get-waiting-room-status Read
List Web3 Hostnames — cloudflare.web3-hostname-list-web3-hostnames Read
Create Web3 Hostname — cloudflare.web3-hostname-create-web3-hostname Write
Web3 Hostname Details — cloudflare.web3-hostname-web3-hostname-details Read
Edit Web3 Hostname — cloudflare.web3-hostname-edit-web3-hostname Write
IPFS Universal Path Gateway Content List Details — cloudflare.web3-hostname-ipfs-universal-path-gateway-content-list-details Read
Update IPFS Universal Path Gateway Content List — cloudflare.web3-hostname-update-ipfs-universal-path-gateway-content-list Write
List IPFS Universal Path Gateway Content List Entries — cloudflare.web3-hostname-list-ipfs-universal-path-gateway-content-list-entries Read
Create IPFS Universal Path Gateway Content List Entry — cloudflare.web3-hostname-create-ipfs-universal-path-gateway-content-list-entry Write
IPFS Universal Path Gateway Content List Entry Details — cloudflare.web3-hostname-ipfs-universal-path-gateway-content-list-entry-details Read
Edit IPFS Universal Path Gateway Content List Entry — cloudflare.web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry Write
List Worker Routes — cloudflare.worker-routes-list-routes Read
Create Worker Route — cloudflare.worker-routes-create-route Write
Delete Worker Route — cloudflare.worker-routes-delete-route Write
Get Worker Route — cloudflare.worker-routes-get-route Read
Replace Worker Route — cloudflare.worker-routes-update-route Write

Connect and use

Connect and use

This connection uses your provider account.

Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.

Get your provider credentials

Follow these steps for Cloudflare, then enter the issued values in the connection form below.

  1. In Cloudflare, open My Profile → API Tokens → Create Token. Choose a template or custom permissions for only the accounts, zones and commands you need, and set an expiry. Copy the token into this connection’s Cloudflare API token field. Use an API token, not a Global API Key. Enable commands, create a Tooluse.net API key, and use the shared MCP configuration. Resource changes may incur Cloudflare charges.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
Cloudflare API token Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Heartbeat response — cloudflare.getheartbeat

Used by Kubernetes readiness and liveness probes, and CI builder by executing test/staging.sh.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Accounts — cloudflare.accounts-list-accounts

List all accounts you have ownership or verified access to.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name string Optional Name of the account.
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.direction string Optional Direction to order results. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an Account — cloudflare.account-creation

Create an Account. To create the Account within an Organization, provide unit.id and omit standalone. To create a standalone Free Account, provide standalone: true and omit unit. Providing both fields is invalid. If you omit both fields, Cloudflare can determine the destination only when the User is an administrator of exactly one Organization. Cloudflare creates the Account in that Organization; otherwise, the request returns an error. Account names are limited to 65 UTF-8 bytes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.Idempotency-Key string Optional Optional key that identifies an Account-creation request. Free Account creation can require exactly one valid key, so API clients should send a key with every Account-creation request. Reuse the same key when retrying the same request. minLength: 1; maxLength: 128
body — Required $ref: "#/definitions/iam_create-account"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a specific account — cloudflare.account-deletion

Delete a specific account (only available for tenant admins at this time). This is a permanent operation that will delete any zones or other resources under the account

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The account ID of the account to be deleted

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Account Details — cloudflare.accounts-account-details

Get information about a specific account that you are a member of.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Account — cloudflare.accounts-update-account

Update an existing account. Account names are limited to 65 UTF-8 bytes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required $ref: "#/definitions/iam_components-schemas-account"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "Demo Account",
    "type": "standard"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List abuse reports against the account — cloudflare.listabusereports

List abuse reports made against domains or other content associated with the account. To list reports that the account submitted, use the submitted abuse reports endpoint instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
query object Optional additionalProperties: false
query.page integer Optional Where in pagination to start listing abuse reports
query.per_page integer Optional How many abuse reports per page to list
query.sort string Optional A property to sort by, followed by the order (id, cdate, domain, type, status)
query.search string Optional Free-text search. Returns reports whose report ID starts with the term or whose domain contains the term, both case-insensitively. Surrounding whitespace is ignored, and an empty value is treated as absent. Combined with the other filters using AND. maxLength: 255
query.domain string Optional Filter by domain name related to the abuse report
query.created_before string Optional Returns reports created before the specified date
query.created_after string Optional Returns reports created after the specified date
query.status — Optional Filter by the status of the report. $ref: "#/definitions/abuse-reports_ReportStatus"
query.type — Optional Filter by the type of the report. $ref: "#/definitions/abuse-reports_ReportType"
query.mitigation_status — Optional Filter reports that have any mitigations in the given status. $ref: "#/definitions/abuse-reports_MitigationStatus"
query.pending_notice boolean Optional Also include reports in an open Notice and Takedown notice period. Combined with mitigation_status using OR, e.g. ?mitigation_status=active&pending_notice=true.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List submitted abuse reports — cloudflare.listsubmittedabusereports

List abuse reports submitted by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
query object Optional additionalProperties: false
query.page integer Optional Page of submitted reports to return. default: 1; minimum: 1
query.per_page integer Optional Number of submitted reports per page. default: 100; minimum: 1; maximum: 200
query.sort string Optional A property and direction to sort by (id, cdate, domain, type, status).
query.id string Optional Filter by report code.
query.domain array Optional Filter by reported domain. This parameter can be specified multiple times.
query.domain[] string Optional
query.created_before string Optional Return reports submitted before this time. format: "date-time"
query.created_after string Optional Return reports submitted after this time. format: "date-time"
query.status array Optional Filter by submitter-facing status. This parameter can be specified multiple times.
query.status[] — Optional $ref: "#/definitions/abuse-reports_SubmittedAbuseReportStatus"
query.type array Optional Filter by report type. This parameter can be specified multiple times.
query.type[] — Optional $ref: "#/definitions/abuse-reports_ReportType"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a submitted abuse report — cloudflare.getsubmittedabusereport

Retrieve a report submitted by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
path.report_id string Required Public report code.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List emails sent to an abuse report submitter — cloudflare.listsubmittedabusereportemails

List successful emails sent to the submitter of a report submitted by the account. Does not include emails sent to customers or hosts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
path.report_id string Required Public report code.
query object Optional additionalProperties: false
query.page integer Optional Page number to retrieve (default 1).
query.per_page integer Optional Number of emails per page (default 20, max 100).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check whether a report can be appealed — cloudflare.checkappealeligibility

Returns whether the report is currently appealable, along with the signals behind that decision: whether it already has an open appeal, how many appeals have been submitted against it, and whether it has at least one mitigation that an appeal could reverse. Report-level appeals are currently available only for DMCA (copyright) reports. For other report types this operation returns the same 404 Report not found response as a report that does not exist for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
path.report_id string Required Abuse Report ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List abuse report emails — cloudflare.listemails

List emails sent to the customer for an abuse report. Returns all successful customer emails sent for the specified abuse report. Does not include emails sent to hosts or submitters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
path.report_id string Required Abuse Report ID
query object Optional additionalProperties: false
query.page integer Optional Page number to retrieve (default 1)
query.per_page integer Optional Number of emails per page (default 20, max 100)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List abuse report mitigations — cloudflare.listmitigations

List mitigations done to remediate the abuse report.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
path.report_id string Required Abuse Report ID
query object Optional additionalProperties: false
query.page integer Optional Where in pagination to start listing abuse reports
query.per_page integer Optional How many abuse reports per page to list
query.sort string Optional A property to sort by, followed by the order enum: ["type,asc","type,desc","effective_date,asc","effective_date,desc","status,asc","status,desc","entity_type,asc","entity_type,desc"]
query.type — Optional Filter by the type of mitigation. This filter parameter can be specified multiple times to include multiple types of mitigations in the result set. $ref: "#/definitions/abuse-reports_MitigationType"
query.effective_before string Optional Returns mitigations that were dispatched before the given date
query.effective_after string Optional Returns mitigation that were dispatched after the given date
query.status — Optional Filter by the status of the mitigation. $ref: "#/definitions/abuse-reports_MitigationStatus"
query.entity_type — Optional Filter by the type of entity the mitigation impacts. $ref: "#/definitions/abuse-reports_MitigatedEntityType"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request review on mitigations — cloudflare.requestreview

Request a review of mitigations applied because of an abuse report, or submit a report-level appeal.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
path.report_id string Required Abuse Report ID
body — Required $ref: "#/definitions/abuse-reports_MitigationAppealRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_id": "example"
  },
  "body": {
    "appeals": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an abuse report against the account — cloudflare.getabusereport

Retrieve the details of an abuse report made against a domain or other content associated with the account. To retrieve a report that the account submitted, use the submitted abuse report endpoint instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare Account ID maxLength: 32
path.report_param string Required Public report ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_param": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Per-portal MCP tool-call timeseries — cloudflare.mcp-portals-api-portal-tool-call-timeseries

Returns daily or monthly tool-call counts for a portal.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.portal_id string Required
query object Optional additionalProperties: false
query.granularity string Optional enum: ["daily","monthly"]; default: "daily"
query.aggregate string Optional enum: ["true","false"]; default: "false"
query.tz string Optional default: "utc"; pattern: "^(utc|Z|\\+(?:(?:0\\d|1[0-3]):[0-5]\\d|14:00)|-(?:(?:0\\d|1[01]):[0-5]\\d|12:00))$"
query.days integer Optional Daily trailing-window size; defaults to 7 and is ignored for monthly minimum: 1; maximum: 179
query.response_status string Optional Response status to count; 'all' counts every status enum: ["success","error","cached","all"]; default: "success"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c",
    "portal_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Per-server MCP tool-call timeseries — cloudflare.mcp-portals-api-server-tool-call-timeseries

Returns daily or monthly tool-call counts for a server.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.server_id string Required
query object Optional additionalProperties: false
query.granularity string Optional enum: ["daily","monthly"]; default: "daily"
query.aggregate string Optional enum: ["true","false"]; default: "false"
query.tz string Optional default: "utc"; pattern: "^(utc|Z|\\+(?:(?:0\\d|1[0-3]):[0-5]\\d|14:00)|-(?:(?:0\\d|1[01]):[0-5]\\d|12:00))$"
query.days integer Optional Daily trailing-window size; defaults to 7 and is ignored for monthly minimum: 1; maximum: 179
query.response_status string Optional Response status to count; 'all' counts every status enum: ["success","error","cached","all"]; default: "success"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c",
    "server_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Account-global MCP tool-call timeseries — cloudflare.mcp-portals-api-account-tool-call-timeseries

Returns daily or monthly tool-call counts across the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.granularity string Optional enum: ["daily","monthly"]; default: "daily"
query.aggregate string Optional enum: ["true","false"]; default: "false"
query.tz string Optional default: "utc"; pattern: "^(utc|Z|\\+(?:(?:0\\d|1[0-3]):[0-5]\\d|14:00)|-(?:(?:0\\d|1[01]):[0-5]\\d|12:00))$"
query.days integer Optional Daily trailing-window size; defaults to 7 and is ignored for monthly minimum: 1; maximum: 179
query.response_status string Optional Response status to count; 'all' counts every status enum: ["success","error","cached","all"]; default: "success"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List MCP Portals — cloudflare.mcp-portals-api-list-portals

Lists all MCP portals configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.search string Optional Search by id, name, hostname

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new MCP Portal — cloudflare.mcp-portals-api-create-portals

Creates a new MCP portal for managing AI tool access through Cloudflare Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.allow_code_mode boolean Optional Deprecated: use code_mode for new integrations. true maps to any non-off Code Mode policy; false maps to code_mode: off. If both fields are sent, they must be consistent or the request returns a 400.
body.code_mode string Optional Code Mode policy for this portal. off: Code Mode is unavailable; query parameters are ignored. opt_in: Code Mode is off by default; clients turn it on with ?codemode=search_and_execute. default_on: Code Mode is on by default; clients can opt out with ?codemode=off. enforced: Code Mode is always on; query parameters are ignored. Defaults to opt_in when omitted on create. If both code_mode and allow_code_mode are sent, they must be consistent or the request returns a 400. enum: ["off","opt_in","default_on","enforced"]
body.description string Optional Optional description of the MCP portal. maxLength: 512
body.hostname string Required Hostname where the MCP portal is available. pattern: "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$"
body.id string Required Unique identifier for the MCP portal. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.name string Required Display name for the MCP portal. maxLength: 350
body.secure_web_gateway boolean Optional Route outbound MCP traffic through Zero Trust Secure Web Gateway. default: false
body.servers array Optional MCP servers attached to the portal and their portal-specific settings. maxItems: 80
body.servers[] object Optional
body.servers[].default_disabled boolean Optional Hide this server's tools and prompts by default. To expose specific capabilities, set enabled: true for them in this server entry's updated_tools or updated_prompts fields when creating or updating the portal.
body.servers[].on_behalf boolean Optional Use end-user OAuth credentials when connecting this server to the portal.
body.servers[].server_id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.servers[].updated_prompts array Optional Portal-specific prompt overrides.
body.servers[].updated_prompts[] object Optional
body.servers[].updated_prompts[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.servers[].updated_prompts[].description string Optional Custom description exposed for the capability.
body.servers[].updated_prompts[].enabled boolean Optional Whether the capability is available through the MCP server.
body.servers[].updated_prompts[].name string Required Name of the tool or prompt capability to override.
body.servers[].updated_tools array Optional Portal-specific tool overrides.
body.servers[].updated_tools[] object Optional
body.servers[].updated_tools[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.servers[].updated_tools[].description string Optional Custom description exposed for the capability.
body.servers[].updated_tools[].enabled boolean Optional Whether the capability is available through the MCP server.
body.servers[].updated_tools[].name string Required Name of the tool or prompt capability to override.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an MCP Portal — cloudflare.mcp-portals-api-delete-portals

Deletes an MCP portal from the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required Unique identifier for the MCP portal. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c",
    "id": "my-mcp-portal"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read details of an MCP Portal — cloudflare.mcp-portals-api-fetch-gateways

Read the details of a single MCP Portal, including its configured servers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required Unique identifier for the MCP portal. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-mcp-portal",
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an MCP Portal — cloudflare.mcp-portals-api-update-portals

Updates an MCP portal configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required Unique identifier for the MCP portal. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
body object Optional
body.allow_code_mode boolean Optional Deprecated: use code_mode for new integrations. true maps to any non-off Code Mode policy; false maps to code_mode: off. If both fields are sent, they must be consistent or the request returns a 400.
body.code_mode string Optional Code Mode policy for this portal. off: Code Mode is unavailable; query parameters are ignored. opt_in: Code Mode is off by default; clients turn it on with ?codemode=search_and_execute. default_on: Code Mode is on by default; clients can opt out with ?codemode=off. enforced: Code Mode is always on; query parameters are ignored. Defaults to opt_in when omitted on create. If both code_mode and allow_code_mode are sent, they must be consistent or the request returns a 400. enum: ["off","opt_in","default_on","enforced"]
body.description string Optional Optional description of the MCP portal. maxLength: 512
body.hostname string Optional Hostname where the MCP portal is available. pattern: "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$"
body.name string Optional Display name for the MCP portal. maxLength: 350
body.secure_web_gateway boolean Optional Route outbound MCP traffic through Zero Trust Secure Web Gateway. default: false
body.servers array Optional MCP servers attached to the portal and their portal-specific settings. maxItems: 80
body.servers[] object Optional
body.servers[].default_disabled boolean Optional Hide this server's tools and prompts by default. To expose specific capabilities, set enabled: true for them in this server entry's updated_tools or updated_prompts fields when creating or updating the portal.
body.servers[].on_behalf boolean Optional Use end-user OAuth credentials when connecting this server to the portal.
body.servers[].server_id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.servers[].updated_prompts array Optional Portal-specific prompt overrides.
body.servers[].updated_prompts[] object Optional
body.servers[].updated_prompts[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.servers[].updated_prompts[].description string Optional Custom description exposed for the capability.
body.servers[].updated_prompts[].enabled boolean Optional Whether the capability is available through the MCP server.
body.servers[].updated_prompts[].name string Required Name of the tool or prompt capability to override.
body.servers[].updated_tools array Optional Portal-specific tool overrides.
body.servers[].updated_tools[] object Optional
body.servers[].updated_tools[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.servers[].updated_tools[].description string Optional Custom description exposed for the capability.
body.servers[].updated_tools[].enabled boolean Optional Whether the capability is available through the MCP server.
body.servers[].updated_tools[].name string Required Name of the tool or prompt capability to override.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-mcp-portal",
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resolve an MCP server OAuth redirect URI — cloudflare.mcp-portals-api-effective-redirect-uri

Resolves the OAuth redirect URI to register for a portal and server based on the server's current shared callback setting. Use the returned value when setting up a new manual OAuth registration. This value is for display only: existing manual OAuth registrations continue using their stored redirect URI, so changing callback settings can make this result differ from the URI used at runtime.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.portal_id string Required Unique identifier for the MCP portal. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.server_id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "portal_id": "my-mcp-portal",
    "server_id": "my-mcp-server",
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List MCP Servers — cloudflare.mcp-portals-api-list-servers

Lists all MCP servers configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.search string Optional Search by id, name

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new MCP Server — cloudflare.mcp-portals-api-create-servers

Creates a new MCP server for connecting to an upstream MCP endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.auth_credentials string Optional Credential configuration for the upstream MCP server. For auth_type "bearer", either a raw token string (e.g. "sk-abc123"), which is wrapped server-side as Authorization: Bearer <token>, or a JSON-encoded object of the form {"headers":{"Header-Name":"value",...}} for custom or multiple static headers (e.g. Cloudflare Access service tokens: {"headers":{"cf-access-client-id":"...","cf-access-client-secret":"..."}}). For auth_type "oauth" with a pre-registered client, send a JSON-encoded object containing auth_mode:"manual", config.authorization_endpoint, config.token_endpoint, and registration_info.client_id. Also provide registration_info.redirect_uris unless is_shared_oauth_callback_enabled is true. Optional fields include config.issuer, config.revocation_endpoint, registration_info.scope, and registration_info.token_endpoint_auth_method. Send the client secret in the separate client_secret field. Omit auth_credentials on update to preserve the existing configuration.
body.auth_type string Required Authentication method used to connect to the upstream MCP server. enum: ["oauth","bearer","unauthenticated"]
body.client_secret string Optional Provides 'client_secret' for a pre-registered OAuth client. This field is accepted on create or update only when 'auth_credentials.auth_mode' is 'manual'. It is required when creating an MCP server with manual OAuth credentials or changing an existing server to use manual OAuth credentials. Omit 'client_secret' on update to preserve the existing secret. Provide a new 'client_secret' to rotate the secret. The secret is never returned by read, create, or update requests.
body.description string | null Optional Optional description of the MCP server. maxLength: 512
body.hostname string Required URL of the upstream MCP endpoint. format: "uri"
body.id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$"
body.is_shared_oauth_callback_enabled boolean Optional When true, per-user authorization uses the shared Cloudflare callback URL as the 'redirect_uri' instead of the portal callback URL. The default is false. Set 'is_shared_oauth_callback_enabled' to true to enable the shared Cloudflare callback URL for this MCP server. default: false
body.name string Required Display name for the MCP server. maxLength: 350
body.secure_web_gateway boolean Optional Route outbound traffic to this MCP server through Zero Trust Secure Web Gateway. default: false
body.updated_prompts array Optional Server-wide prompt capability overrides.
body.updated_prompts[] object Optional
body.updated_prompts[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.updated_prompts[].description string Optional Custom description exposed for the capability.
body.updated_prompts[].enabled boolean Optional Whether the capability is available through the MCP server.
body.updated_prompts[].name string Required Name of the tool or prompt capability to override.
body.updated_tools array Optional Server-wide tool capability overrides.
body.updated_tools[] object Optional
body.updated_tools[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.updated_tools[].description string Optional Custom description exposed for the capability.
body.updated_tools[].enabled boolean Optional Whether the capability is available through the MCP server.
body.updated_tools[].name string Required Name of the tool or prompt capability to override.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an MCP Server — cloudflare.mcp-portals-api-delete-servers

Deletes an MCP server from the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c",
    "id": "my-mcp-server"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read the details of an MCP Server — cloudflare.mcp-portals-api-fetch-servers

Retrieves an MCP server's configuration and capability sync state.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c",
    "id": "my-mcp-server"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an MCP Server — cloudflare.mcp-portals-api-update-servers

Updates an MCP server's configuration and credentials.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
body object Optional
body.auth_credentials string Optional Credential configuration for the upstream MCP server. For auth_type "bearer", either a raw token string (e.g. "sk-abc123"), which is wrapped server-side as Authorization: Bearer <token>, or a JSON-encoded object of the form {"headers":{"Header-Name":"value",...}} for custom or multiple static headers (e.g. Cloudflare Access service tokens: {"headers":{"cf-access-client-id":"...","cf-access-client-secret":"..."}}). For auth_type "oauth" with a pre-registered client, send a JSON-encoded object containing auth_mode:"manual", config.authorization_endpoint, config.token_endpoint, and registration_info.client_id. Also provide registration_info.redirect_uris unless is_shared_oauth_callback_enabled is true. Optional fields include config.issuer, config.revocation_endpoint, registration_info.scope, and registration_info.token_endpoint_auth_method. Send the client secret in the separate client_secret field. Omit auth_credentials on update to preserve the existing configuration.
body.client_secret string Optional Provides 'client_secret' for a pre-registered OAuth client. This field is accepted on create or update only when 'auth_credentials.auth_mode' is 'manual'. It is required when creating an MCP server with manual OAuth credentials or changing an existing server to use manual OAuth credentials. Omit 'client_secret' on update to preserve the existing secret. Provide a new 'client_secret' to rotate the secret. The secret is never returned by read, create, or update requests.
body.description string | null Optional Optional description of the MCP server. maxLength: 512
body.is_shared_oauth_callback_enabled boolean Optional When true, per-user authorization uses the shared Cloudflare callback URL as the 'redirect_uri' instead of the portal callback URL. The default is false. Set 'is_shared_oauth_callback_enabled' to true to enable the shared Cloudflare callback URL for this MCP server. default: false
body.name string Optional Display name for the MCP server. maxLength: 350
body.secure_web_gateway boolean Optional Route outbound traffic to this MCP server through Zero Trust Secure Web Gateway. default: false
body.updated_prompts array Optional Server-wide prompt capability overrides.
body.updated_prompts[] object Optional
body.updated_prompts[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.updated_prompts[].description string Optional Custom description exposed for the capability.
body.updated_prompts[].enabled boolean Optional Whether the capability is available through the MCP server.
body.updated_prompts[].name string Required Name of the tool or prompt capability to override.
body.updated_tools array Optional Server-wide tool capability overrides.
body.updated_tools[] object Optional
body.updated_tools[].alias string Optional Custom name exposed for the capability. maxLength: 40; pattern: "^[a-zA-Z0-9]+([_-][a-zA-Z0-9]+)*$"
body.updated_tools[].description string Optional Custom description exposed for the capability.
body.updated_tools[].enabled boolean Optional Whether the capability is available through the MCP server.
body.updated_tools[].name string Required Name of the tool or prompt capability to override.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-mcp-server",
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Sync MCP Server Capabilities — cloudflare.mcp-portals-api-sync-server

Syncs an MCP server's capabilities and returns the updated server state, including any connection errors.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required Unique identifier for the MCP server. minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-mcp-server",
    "account_id": "a86a8f5c339544d7bdc89926de14fb8c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access applications — cloudflare.access-applications-list-access-applications

Lists all Access applications in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.name string Optional The name of the app.
query.domain string Optional The domain of the app.
query.aud string Optional The aud of the app.
query.target_attributes string Optional Target Criteria attributes in key=value format.
query.exact boolean Optional True for only exact string matches against passed name/domain query parameters.
query.search string Optional Search for apps by other listed query parameters.
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 1000; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an Access application — cloudflare.access-applications-add-an-application

Adds a new application to Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_app_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "self_hosted",
    "oauth_configuration": {},
    "user_populations": [
      "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List short-lived certificate CAs — cloudflare.access-short-lived-certificate-c-as-list-short-lived-certificate-c-as

Lists short-lived certificate CAs and their public keys.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 100; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a short-lived certificate CA — cloudflare.access-short-lived-certificate-c-as-delete-a-short-lived-c-53df2aaf7d

Deletes a short-lived certificate CA.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a short-lived certificate CA — cloudflare.access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca

Fetches a short-lived certificate CA and its public key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a short-lived certificate CA — cloudflare.access-short-lived-certificate-c-as-create-a-short-lived-c-21a6dd88cb

Generates a new short-lived certificate CA and public key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access application policies — cloudflare.access-policies-list-access-app-policies

Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required The application ID. $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 200; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an Access application policy — cloudflare.access-policies-create-an-access-policy

Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required The application ID. $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_app_policy_write_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "decision": "allow",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Access application policy — cloudflare.access-policies-delete-an-access-policy

Deletes an Access policy specific to an application. To delete a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required The application ID. $ref: "#/definitions/access_uuid"
path.policy_id — Required The policy ID. $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access application policy — cloudflare.access-policies-get-an-access-policy

Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required The application ID. $ref: "#/definitions/access_uuid"
path.policy_id — Required The policy ID. $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an Access application policy — cloudflare.access-policies-update-an-access-policy

Updates an Access policy specific to an application. To update a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required The application ID. $ref: "#/definitions/access_uuid"
path.policy_id — Required The policy ID. $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_app_policy_write_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "decision": "allow",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Convert an Access application policy to a reusable policy — cloudflare.access-policies-convert-reusable

Converts an application-scoped policy to a reusable policy. The policy will no longer be exclusively scoped to the application. Further updates to the policy should go through the /accounts/{account_id}/policies/{uid} endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required The application ID. $ref: "#/definitions/access_uuid"
path.policy_id — Required The policy ID. $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List authenticator device AAGUIDs — cloudflare.access-authenticator-device-aaguids-list

Returns a list of Authenticator Device AAGUIDs for MFA configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List mTLS certificates — cloudflare.access-mtls-authentication-list-mtls-certificates

Lists all mTLS root certificates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 50; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an mTLS certificate — cloudflare.access-mtls-authentication-add-an-mtls-certificate

Adds a new mTLS root certificate to Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.associated_hostnames — Optional $ref: "#/definitions/access_associated_hostnames"
body.certificate string Required The certificate content.
body.name — Required $ref: "#/definitions/access_name-7"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all mTLS hostname settings — cloudflare.access-mtls-authentication-list-mtls-certificates-hostname-settings

List all mTLS hostname settings for this account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an mTLS certificate's hostname settings — cloudflare.access-mtls-authentication-update-an-mtls-certificate-settings

Updates an mTLS certificate's hostname settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.settings array Required
body.settings[] — Optional $ref: "#/definitions/access_settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "settings": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an mTLS certificate — cloudflare.access-mtls-authentication-delete-an-mtls-certificate

Deletes an mTLS certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an mTLS certificate — cloudflare.access-mtls-authentication-get-an-mtls-certificate

Fetches a single mTLS certificate.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an mTLS certificate — cloudflare.access-mtls-authentication-update-an-mtls-certificate

Updates a configured mTLS certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.associated_hostnames — Required $ref: "#/definitions/access_associated_hostnames"
body.name — Optional $ref: "#/definitions/access_name-7"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "associated_hostnames": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom pages — cloudflare.access-custom-pages-list-custom-pages

List custom pages

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 50; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom page — cloudflare.access-custom-pages-create-a-custom-page

Create a custom page

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Optional $ref: "#/definitions/access_custom_page"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate a custom page template — cloudflare.access-custom-pages-validate-a-custom-page-template

Validate a Liquid template and return its errors and warnings without persisting it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Optional $ref: "#/definitions/access_custom_page_validate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom page — cloudflare.access-custom-pages-delete-a-custom-page

Delete a custom page

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_page_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_page_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom page — cloudflare.access-custom-pages-get-a-custom-page

Fetches a custom page and also returns its HTML.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_page_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_page_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom page — cloudflare.access-custom-pages-update-a-custom-page

Update a custom page

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_page_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Optional $ref: "#/definitions/access_custom_page"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_page_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SSH Certificate Authorities (CA) — cloudflare.access-gateway-ca-list-ssh-ca

Lists SSH Certificate Authorities (CA).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a new SSH Certificate Authority (CA) — cloudflare.access-gateway-ca-add-an-ssh-ca

Adds a new SSH Certificate Authority (CA).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an SSH Certificate Authority (CA) — cloudflare.access-gateway-ca-delete-an-ssh-ca

Deletes an SSH Certificate Authority.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access groups — cloudflare.access-groups-list-access-groups

Lists all Access groups.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.name string Optional The name of the group.
query.search string Optional Search for groups by other listed query parameters.
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 1000; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an Access group — cloudflare.access-groups-create-an-access-group

Creates a new Access group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.exclude — Optional $ref: "#/definitions/access_exclude"
body.include — Required $ref: "#/definitions/access_include"
body.is_default — Optional $ref: "#/definitions/access_is_default"
body.name — Required $ref: "#/definitions/access_name-6"
body.require — Optional $ref: "#/definitions/access_require"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Access group — cloudflare.access-groups-delete-an-access-group

Deletes an Access group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access group — cloudflare.access-groups-get-an-access-group

Fetches a single Access group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an Access group — cloudflare.access-groups-update-an-access-group

Updates a configured Access group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.exclude — Optional $ref: "#/definitions/access_exclude"
body.include — Required $ref: "#/definitions/access_include"
body.is_default — Optional $ref: "#/definitions/access_is_default"
body.name — Required $ref: "#/definitions/access_name-6"
body.require — Optional $ref: "#/definitions/access_require"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access identity providers — cloudflare.access-identity-providers-list-access-identity-providers

Lists all configured identity providers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.scim_enabled string Optional Indicates to Access to only retrieve identity providers that have the System for Cross-Domain Identity Management (SCIM) enabled.
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 200; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an Access identity provider — cloudflare.access-identity-providers-add-an-access-identity-provider

Adds a new identity provider to Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_identity-providers"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Widget Corps IDP",
    "type": "onetimepin",
    "config": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Access identity provider — cloudflare.access-identity-providers-delete-an-access-identity-provider

Deletes an identity provider from Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access identity provider — cloudflare.access-identity-providers-get-an-access-identity-provider

Fetches a configured identity provider.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an Access identity provider — cloudflare.access-identity-providers-update-an-access-identity-provider

Updates a configured identity provider.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_identity-providers"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Widget Corps IDP",
    "type": "onetimepin",
    "config": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create SAML encryption certificate for Identity Provider — cloudflare.access-identity-providers-create-saml-certificate-for-iden-2f0afb5921

Creates a new SAML encryption certificate set and assigns it to the specified SAML Identity Provider. This endpoint is idempotent - if the IdP already has a certificate set assigned, the existing certificate set is returned with a 200 status.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SCIM Group resources — cloudflare.access-identity-providers-list-scim-group-resources

Lists SCIM Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.cf_resource_id — Optional $ref: "#/definitions/access_cf_resource_id"
query.idp_resource_id — Optional $ref: "#/definitions/access_idp_resource_id"
query.name — Optional $ref: "#/definitions/access_name-4"
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 100; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a SCIM Group resource — cloudflare.access-identity-providers-delete-scim-group-resource

Deletes a SCIM Group resource from the identity provider's SCIM population.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
path.group_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a SCIM Group resource — cloudflare.access-identity-providers-get-scim-group-resource

Returns a SCIM Group resource, including its direct members, synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
path.group_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SCIM User resources — cloudflare.access-identity-providers-list-scim-user-resources

Lists SCIM User resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.cf_resource_id — Optional $ref: "#/definitions/access_cf_resource_id-2"
query.idp_resource_id — Optional $ref: "#/definitions/access_idp_resource_id-2"
query.username — Optional $ref: "#/definitions/access_username"
query.email — Optional $ref: "#/definitions/access_email"
query.name — Optional $ref: "#/definitions/access_name-5"
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 100; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a SCIM User resource — cloudflare.access-identity-providers-delete-scim-user-resource

Deletes a SCIM User resource from the identity provider's SCIM population.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a SCIM User resource — cloudflare.access-identity-providers-get-scim-user-resource

Returns a SCIM User resource synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IdP federation grants — cloudflare.access-idp-federation-grants-list

Lists the IdP federation grants owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an IdP federation grant — cloudflare.access-idp-federation-grants-create

Creates an IdP federation grant for the specified identity provider, making it available for federation to other accounts in the same Cloudflare organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_idp_federation_grant_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "idp_id": "a79de439-0e7f-4ebb-8a02-222222222222"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an IdP federation grant — cloudflare.access-idp-federation-grants-delete

Deletes an IdP federation grant. The identity provider remains in the account, but it is no longer available for federation to other accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.grant_id — Required UID of the IdP federation grant. $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "grant_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an IdP federation grant — cloudflare.access-idp-federation-grants-get

Retrieves a single IdP federation grant by its UID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.grant_id — Required UID of the IdP federation grant. $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "grant_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Access key configuration — cloudflare.access-key-configuration-get-the-access-key-configuration

Gets the Access key rotation settings for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the Access key configuration — cloudflare.access-key-configuration-update-the-access-key-configuration

Updates the Access key rotation settings for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.key_rotation_interval_days — Required $ref: "#/definitions/access_key_rotation_interval_days"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "key_rotation_interval_days": 30
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate Access keys — cloudflare.access-key-configuration-rotate-access-keys

Perfoms a key rotation for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Access authentication logs — cloudflare.access-authentication-logs-get-access-authentication-logs

Gets a list of Access authentication audit logs for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of log entries to retrieve. default: 25
query.direction string Optional The chronological sorting order for the logs. enum: ["desc","asc"]; default: "desc"
query.since string Optional The earliest event timestamp to query. format: "date-time"
query.until string Optional The latest event timestamp to query. format: "date-time"
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 25
query.email — Optional Filter by user email. Match mode is controlled by emailOp (preferred) or the legacy email_exact flag. - Default (no emailOp, email_exact=false or unset): substring match — [email protected] returns all events with that domain. - Exact match: set emailOp=eq (preferred) or email_exact=true — e.g. [email protected]&email_exact=true returns only that user. - Explicit substring match: set emailOp=contains (without email_exact=true). When both are set, email_exact=true takes precedence and the match is exact. - Exclusion: set emailOp=neq. With email_exact=true this is an exact-value exclusion; without it, a fuzzy substring exclusion. $ref: "#/definitions/access_email-3"
query.email_exact boolean Optional When true, email is matched exactly instead of substring matching. default: false
query.user_id — Optional Deprecated. Accepted for backward compatibility but no longer applied as a filter. Use email instead. $ref: "#/definitions/access_user_id"
query.allowedOp string Optional Operator for the allowed filter. enum: ["eq","neq"]; default: "eq"
query.country_codeOp string Optional Operator for the country_code filter. enum: ["eq","neq"]; default: "eq"
query.app_typeOp string Optional Operator for the app_type filter. enum: ["eq","neq"]; default: "eq"
query.app_uidOp string Optional Operator for the app_uid filter. enum: ["eq","neq"]; default: "eq"
query.ray_idOp string Optional Operator for the ray_id filter. enum: ["eq","neq"]; default: "eq"
query.emailOp string Optional Operator for the email filter. contains performs a substring (case-sensitive) match. When email_exact=true is also set, email_exact takes precedence and contains is ignored. enum: ["eq","neq","contains"]; default: "eq"
query.idpOp string Optional Operator for the idp filter. enum: ["eq","neq"]; default: "eq"
query.non_identityOp string Optional Operator for the non_identity filter. enum: ["eq","neq"]; default: "eq"
query.user_idOp string Optional Deprecated. Accepted for backward compatibility but no longer applied as a filter (the user_id parameter is itself deprecated). enum: ["eq","neq"]; default: "eq"
query.fields string Optional Comma-separated list of fields to include in the response. When omitted, all fields are returned.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access JIT request logs — cloudflare.access-jit-request-logs-list

Lists account-wide Access JIT request logs reconstructed from request lifecycle events.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 25; maximum: 1000
query.status — Optional $ref: "#/definitions/access_jit_request_status"
query.search string Optional Case-insensitive search over request ID, requester email, application audience, and application hostname.
query.since string Optional The earliest request timestamp to query. Defaults to 366 days before the current time. format: "date-time"
query.until string Optional The latest request timestamp to query. Defaults to the current time. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access JIT request log — cloudflare.access-jit-request-logs-get

Gets an account-scoped Access JIT request summary and its lifecycle events in chronological order.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.knock_request_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "knock_request_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access SCIM update logs — cloudflare.access-scim-update-logs-list-access-scim-update-logs

Lists Access SCIM update logs that maintain a record of updates made to User and Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Required additionalProperties: false
query.limit — Optional $ref: "#/definitions/access_limit"
query.direction — Optional $ref: "#/definitions/access_direction"
query.since — Optional $ref: "#/definitions/access_since"
query.until — Optional $ref: "#/definitions/access_until"
query.idp_id — Required $ref: "#/definitions/access_idp_id"
query.status — Optional $ref: "#/definitions/access_status-2"
query.resource_type — Optional $ref: "#/definitions/access_resource_type"
query.request_method — Optional $ref: "#/definitions/access_request_method"
query.resource_user_email — Optional $ref: "#/definitions/access_resource_user_email"
query.resource_group_name — Optional $ref: "#/definitions/access_resource_group_name"
query.cf_resource_id — Optional $ref: "#/definitions/access_cf_resource_id-3"
query.idp_resource_id — Optional $ref: "#/definitions/access_idp_resource_id-3"
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 20; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "idp_id": [
      "df7e2w5f-02b7-4d9d-af26-8d1988fca630",
      "0194ae2c-efcf-7cfb-8884-055f1a161fa5"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get your Zero Trust organization — cloudflare.zero-trust-organization-get-your-zero-trust-organization

Returns the configuration for your Zero Trust organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create your Zero Trust organization — cloudflare.zero-trust-organization-create-your-zero-trust-organization

Sets up a Zero Trust organization for your account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.allow_authenticate_via_warp — Optional $ref: "#/definitions/access_allow_authenticate_via_warp"
body.auth_domain — Optional $ref: "#/definitions/access_auth_domain"
body.auto_redirect_to_identity — Optional $ref: "#/definitions/access_auto_redirect_to_identity"
body.deny_unmatched_requests — Optional $ref: "#/definitions/access_deny_unmatched_requests"
body.deny_unmatched_requests_exempted_zone_names — Optional $ref: "#/definitions/access_deny_unmatched_requests_exempted_zone_names"
body.disable_end_user_app_creation — Optional $ref: "#/definitions/access_disable_end_user_app_creation"
body.is_ui_read_only — Optional $ref: "#/definitions/access_is_ui_read_only"
body.login_design — Optional $ref: "#/definitions/access_login_design"
body.mfa_config — Optional $ref: "#/definitions/access_org_mfa_config"
body.mfa_piv_key_requirements — Optional $ref: "#/definitions/access_mfa_piv_key_requirements"
body.mfa_required_for_all_apps — Optional $ref: "#/definitions/access_mfa_required_for_all_apps"
body.name — Optional $ref: "#/definitions/access_name"
body.service_token_inactivity — Optional $ref: "#/definitions/access_service_token_inactivity"
body.session_duration — Optional $ref: "#/definitions/access_session_duration"
body.strict_service_token_auth — Optional $ref: "#/definitions/access_strict_service_token_auth"
body.ui_read_only_toggle_reason — Optional $ref: "#/definitions/access_ui_read_only_toggle_reason"
body.user_seat_expiration_inactive_time — Optional $ref: "#/definitions/access_user_seat_expiration_inactive_time"
body.warp_auth_non_browser_401 — Optional $ref: "#/definitions/access_warp_auth_non_browser_401"
body.warp_auth_session_duration — Optional $ref: "#/definitions/access_warp_auth_session_duration"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update your Zero Trust organization — cloudflare.zero-trust-organization-update-your-zero-trust-organization

Updates the configuration for your Zero Trust organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.allow_authenticate_via_warp — Optional $ref: "#/definitions/access_allow_authenticate_via_warp"
body.auth_domain — Optional $ref: "#/definitions/access_auth_domain"
body.auto_redirect_to_identity — Optional $ref: "#/definitions/access_auto_redirect_to_identity"
body.custom_pages — Optional $ref: "#/definitions/access_custom_pages"
body.deny_unmatched_requests — Optional $ref: "#/definitions/access_deny_unmatched_requests"
body.deny_unmatched_requests_exempted_zone_names — Optional $ref: "#/definitions/access_deny_unmatched_requests_exempted_zone_names"
body.disable_end_user_app_creation — Optional $ref: "#/definitions/access_disable_end_user_app_creation"
body.is_ui_read_only — Optional $ref: "#/definitions/access_is_ui_read_only"
body.login_design — Optional $ref: "#/definitions/access_login_design"
body.mfa_config — Optional $ref: "#/definitions/access_org_mfa_config"
body.mfa_piv_key_requirements — Optional $ref: "#/definitions/access_mfa_piv_key_requirements"
body.mfa_required_for_all_apps — Optional $ref: "#/definitions/access_mfa_required_for_all_apps"
body.name — Optional $ref: "#/definitions/access_name"
body.service_token_inactivity — Optional $ref: "#/definitions/access_service_token_inactivity"
body.session_duration — Optional $ref: "#/definitions/access_session_duration"
body.strict_service_token_auth — Optional $ref: "#/definitions/access_strict_service_token_auth"
body.ui_read_only_toggle_reason — Optional $ref: "#/definitions/access_ui_read_only_toggle_reason"
body.user_seat_expiration_inactive_time — Optional $ref: "#/definitions/access_user_seat_expiration_inactive_time"
body.warp_auth_non_browser_401 — Optional $ref: "#/definitions/access_warp_auth_non_browser_401"
body.warp_auth_session_duration — Optional $ref: "#/definitions/access_warp_auth_session_duration"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get your Zero Trust organization DoH settings — cloudflare.zero-trust-organization-get-your-zero-trust-organization-doh-settings

Returns the DoH settings for your Zero Trust organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update your Zero Trust organization DoH settings — cloudflare.zero-trust-organization-update-your-zero-trust-organizatio-c7ffe55106

Updates the DoH settings for your Zero Trust organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Optional
body.doh_jwt_duration — Optional $ref: "#/definitions/access_doh_jwt_duration"
body.service_token_id string Optional The uuid of the service token you want to use for DoH authentication

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke all Access tokens for a user — cloudflare.zero-trust-organization-revoke-all-access-tokens-for-a-user

Revokes a user's access across all applications.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.devices boolean Optional When set to true, all devices associated with the user will be revoked.
body object Required
body.devices boolean Optional When set to true, all devices associated with the user will be revoked.
body.email string Required The email of the user to revoke.
body.user_uid string Optional The uuid of the user to revoke.
body.warp_session_reauth boolean Optional When set to true, the user will be required to re-authenticate to WARP for all Gateway policies that enforce a WARP client session duration. When false, the user’s WARP session will remain active

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Zero Trust organization trust settings — cloudflare.zero-trust-organization-delete-trust-settings

Resets the trust settings for your Zero Trust organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust organization trust settings — cloudflare.zero-trust-organization-get-trust-settings

Returns the trust settings for your Zero Trust organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zero Trust organization trust settings — cloudflare.zero-trust-organization-update-trust-settings

Updates the trust settings for your Zero Trust organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.grant_trust_to_all_accounts_in_org — Optional $ref: "#/definitions/access_grant_trust_to_all_accounts_in_org"
body.trusting_accounts — Optional $ref: "#/definitions/access_trusting_accounts"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Zero Trust organization trust settings — cloudflare.zero-trust-organization-replace-trust-settings

Replaces the trust settings for your Zero Trust organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.grant_trust_to_all_accounts_in_org — Required $ref: "#/definitions/access_grant_trust_to_all_accounts_in_org"
body.trusting_accounts — Optional $ref: "#/definitions/access_trusting_accounts"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "grant_trust_to_all_accounts_in_org": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access reusable policies — cloudflare.access-policies-list-access-reusable-policies

Lists Access reusable policies.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 100; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an Access reusable policy — cloudflare.access-policies-create-an-access-reusable-policy

Creates a new Access reusable policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_policy_req"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "decision": "allow",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Access reusable policy — cloudflare.access-policies-delete-an-access-reusable-policy

Deletes an Access reusable policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.policy_id — Required $ref: "#/definitions/access_uuid-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access reusable policy — cloudflare.access-policies-get-an-access-reusable-policy

Fetches a single Access reusable policy.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.policy_id — Required $ref: "#/definitions/access_uuid-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an Access reusable policy — cloudflare.access-policies-update-an-access-reusable-policy

Updates a Access reusable policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.policy_id — Required $ref: "#/definitions/access_uuid-2"
body — Required $ref: "#/definitions/access_policy_req"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "name": "Allow devs",
    "decision": "allow",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start Access policy test — cloudflare.access-policy-tests

Starts an Access policy test.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_policy_init_req"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the current status of a given Access policy test — cloudflare.access-policy-tests-get-an-update

Fetches the current status of a given Access policy test.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.policy_test_id — Required $ref: "#/definitions/access_policy_test_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_test_id": "f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access policy test users page — cloudflare.access-policy-tests-get-a-user-page

Fetches a single page of user results from an Access policy test.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.policy_test_id — Required $ref: "#/definitions/access_policy_test_id"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional default: 25; maximum: 1000
query.status string Optional Filter users by their policy evaluation status. enum: ["success","fail","error"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_test_id": "f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SAML certificate sets — cloudflare.access-saml-certificates-list-certificate-sets

Returns a paginated list of the organization's SAML encryption certificate sets. Each certificate set includes the current and (if present) previous certificates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 25; minimum: 1; maximum: 1000
query.id string Optional Filter by SAML certificate set UID. Accepts a comma-separated list of UIDs.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SAML certificate set — cloudflare.access-saml-certificates-get-certificate-set

Retrieves a specific SAML encryption certificate set by its UID, including both current and previous certificates if available.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.saml_cert_set_id — Required UID of the SAML certificate set. $ref: "#/definitions/access_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "saml_cert_set_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Download current certificate in PEM format — cloudflare.access-saml-certificates-get-pem

Downloads the current SAML encryption certificate's public key in PEM format for the specified certificate set. This endpoint is useful for providing the certificate to Identity Providers for SAML assertion encryption configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.saml_cert_set_id — Required UID of the SAML certificate set. $ref: "#/definitions/access_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "saml_cert_set_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate SAML certificate — cloudflare.access-saml-certificates-rotate-certificate

Rotates the SAML encryption certificates within the specified certificate set. This generates a new certificate and moves the current certificate to the previous slot. If a previous certificate exists, it will be deactivated and removed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.saml_cert_set_id — Required UID of the SAML certificate set to rotate. $ref: "#/definitions/access_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "saml_cert_set_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a user seat — cloudflare.zero-trust-seats-update-a-user-seat

Removes a user from a Zero Trust seat when both access_seat and gateway_seat are set to false.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier-2"
body — Required $ref: "#/definitions/access_seats_definition"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List service tokens — cloudflare.access-service-tokens-list-service-tokens

Lists all service tokens.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.name string Optional The name of the service token.
query.search string Optional Search for service tokens by other listed query parameters.
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 1000; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a service token — cloudflare.access-service-tokens-create-a-service-token

Generates a new service token. Note: This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.client_secret_version — Optional $ref: "#/definitions/access_client_secret_version"
body.duration — Optional $ref: "#/definitions/access_duration"
body.enabled — Optional $ref: "#/definitions/access_enabled"
body.name — Required $ref: "#/definitions/access_name-2"
body.previous_client_secret_expires_at — Optional $ref: "#/definitions/access_previous_client_secret_expires_at"
body.tags — Optional $ref: "#/definitions/access_tags"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "CI/CD token"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a service token — cloudflare.access-service-tokens-delete-a-service-token

Deletes a service token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a service token — cloudflare.access-service-tokens-get-a-service-token

Fetches a single service token.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a service token — cloudflare.access-service-tokens-update-a-service-token

Updates a configured service token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.client_secret_version — Optional $ref: "#/definitions/access_client_secret_version"
body.duration — Optional $ref: "#/definitions/access_duration"
body.enabled — Optional $ref: "#/definitions/access_enabled"
body.name — Optional $ref: "#/definitions/access_name-2"
body.previous_client_secret_expires_at — Optional $ref: "#/definitions/access_previous_client_secret_expires_at"
body.tags — Optional $ref: "#/definitions/access_tags"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Refresh a service token — cloudflare.access-service-tokens-refresh-a-service-token

Refreshes the expiration of a service token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate a service token — cloudflare.access-service-tokens-rotate-a-service-token

Generates a new Client Secret for a service token and revokes the old one.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Optional
body.previous_client_secret_expires_at string Optional The expiration of the previous client_secret. If not provided, it defaults to the current timestamp in order to immediately expire the previous secret. If the service token was reported as leaked, this must not be in the future; the leaked secret is discarded immediately. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tags — cloudflare.access-tags-list-tags

List tags

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 50; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a tag — cloudflare.access-tags-create-tag

Create a tag

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Optional
body.name — Optional $ref: "#/definitions/access_name-13"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a tag — cloudflare.access-tags-delete-a-tag

Delete a tag

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.tag_name — Required $ref: "#/definitions/access_name-13"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tag_name": "engineers"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a tag — cloudflare.access-tags-get-a-tag

Get a tag

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.tag_name — Required $ref: "#/definitions/access_name-13"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tag_name": "engineers"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a tag — cloudflare.access-tags-update-a-tag

Update a tag

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.tag_name — Required $ref: "#/definitions/access_name-13"
body — Optional $ref: "#/definitions/access_tag_without_app_count"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tag_name": "engineers"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List user populations — cloudflare.access-user-populations-list-user-populations

Lists the user populations in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 100; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a user population — cloudflare.access-user-populations-create-user-population

Creates a user population in an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_user_population_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Employees"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a user population — cloudflare.access-user-populations-delete-user-population

Deletes a user population that is not attached to an application.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user population — cloudflare.access-user-populations-get-user-population

Fetches a user population.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a user population — cloudflare.access-user-populations-update-user-population

Updates a user population's name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"
body — Required $ref: "#/definitions/access_user_population_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "name": "Employees"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List users in a user population — cloudflare.access-user-populations-list-users

Lists SCIM users in a user population.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"
query object Optional additionalProperties: false
query.filter string Optional A SCIM filter expression.
query.startIndex integer Optional The 1-based index of the first result to return. default: 1; minimum: 1
query.count integer Optional The maximum number of results to return. minimum: 0
query.attributes string Optional Comma-separated SCIM attributes to return.
query.excludedAttributes string Optional Comma-separated SCIM attributes to exclude from the response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a user population user — cloudflare.access-user-populations-create-user

Creates a SCIM user in a user population.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"
body — Required $ref: "#/definitions/access_scim_user"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a user population user — cloudflare.access-user-populations-delete-user

Deletes a SCIM user from a user population.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"
path.user_id string Required The SCIM user identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user population user — cloudflare.access-user-populations-get-user

Fetches a SCIM user from a user population.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"
path.user_id string Required The SCIM user identifier.
query object Optional additionalProperties: false
query.attributes string Optional Comma-separated SCIM attributes to return.
query.excludedAttributes string Optional Comma-separated SCIM attributes to exclude from the response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a user population user — cloudflare.access-user-populations-update-user

Updates a SCIM user in a user population.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"
path.user_id string Required The SCIM user identifier.
body — Required $ref: "#/definitions/access_scim_patch_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "user_id": "example"
  },
  "body": {
    "Operations": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace a user population user — cloudflare.access-user-populations-replace-user

Replaces a SCIM user in a user population.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
path.user_population_id — Required $ref: "#/definitions/access_uuid"
path.user_id string Required The SCIM user identifier.
body — Required $ref: "#/definitions/access_scim_user"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_population_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "user_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get users — cloudflare.zero-trust-users-get-users

Gets a list of users for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
query object Optional additionalProperties: false
query.name string Optional The name of the user.
query.email string Optional The email of the user.
query.search string Optional Search for users by other listed query parameters.
query.page integer Optional Page number of results. default: 1
query.per_page integer Optional Number of results per page. default: 1000; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a user — cloudflare.zero-trust-users-create-user

Creates a new user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.email — Required $ref: "#/definitions/access_email-2"
body.name — Optional $ref: "#/definitions/access_name-10"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a user — cloudflare.zero-trust-users-delete-user

Deletes a specific user for an account. This will also revoke any active seats and tokens for the user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user — cloudflare.zero-trust-users-get-user

Gets a specific user for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a user — cloudflare.zero-trust-users-update-user

Updates a specific user's name for an account. Requires the user's current email as confirmation (email cannot be changed).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.email — Required $ref: "#/definitions/access_email-2"
body.name — Required $ref: "#/definitions/access_name-10"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Jane Doe",
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get active sessions — cloudflare.zero-trust-users-get-active-sessions

Get active sessions for a single user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get single active session — cloudflare.zero-trust-users-get-active-session

Get an active session for a single user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
path.nonce — Required $ref: "#/definitions/access_nonce"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "nonce": "X1aXj1lFVcqqyoXF"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get failed logins — cloudflare.zero-trust-users-get-failed-logins

Get all failed login attempts for a single user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get last seen identity — cloudflare.zero-trust-users-get-last-seen-identity

Get last seen identity for a single user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a user's authenticator — cloudflare.zero-trust-users-delete-mfa-authenticator

Deletes a specific MFA device or passkey, including a PIV key or FIDO2 key enrollment, for a user. Admin deletion remains available when MFA is disabled. Successful deletion revokes the enrollment and returns a null result.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
path.authenticator_id — Required $ref: "#/definitions/access_authenticator_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "authenticator_id": "test-authenticator-id-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a user's passkey — cloudflare.zero-trust-users-delete-passkey

Alias of the authenticator deletion endpoint for passkey management. The identifier is the passkey's authenticator ID from the last-seen identity response. Successful deletion revokes the enrollment and returns a null result.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id — Required $ref: "#/definitions/access_uuid"
path.account_id — Required $ref: "#/definitions/access_identifier"
path.authenticator_id — Required $ref: "#/definitions/access_authenticator_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "authenticator_id": "test-authenticator-id-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Address Maps — cloudflare.ip-address-management-address-maps-list-address-maps

List all address maps owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Address Map — cloudflare.ip-address-management-address-maps-create-address-map

Create a new address map under the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.description — Optional $ref: "#/definitions/addressing_description-2"
body.enabled — Optional $ref: "#/definitions/addressing_enabled"
body.ips array Optional
body.ips[] — Optional $ref: "#/definitions/addressing_ip_address"
body.memberships — Optional $ref: "#/definitions/addressing_membership_requests"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Address Map — cloudflare.ip-address-management-address-maps-delete-address-map

Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Address Map Details — cloudflare.ip-address-management-address-maps-address-map-details

Show a particular address map owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Address Map — cloudflare.ip-address-management-address-maps-update-address-map

Modify properties of an address map owned by the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.default_sni — Optional $ref: "#/definitions/addressing_default_sni"
body.description — Optional $ref: "#/definitions/addressing_description-2"
body.enabled — Optional $ref: "#/definitions/addressing_enabled"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an account membership from an Address Map — cloudflare.ip-address-management-address-maps-remove-an-account-membe-50c3d1b2c5

Remove an account as a member of a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.member_account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "member_account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an account membership to an Address Map — cloudflare.ip-address-management-address-maps-add-an-account-membersh-c09c729fdc

Add an account as a member of a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.member_account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "member_account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Multiple IPs from an Address Map — cloudflare.ip-address-management-address-maps-remove-multiple-ips-fro-d3aaba0685

Remove multiple IPs from a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.ips array Required
body.ips[] — Optional $ref: "#/definitions/addressing_ip_address"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {
    "ips": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Multiple IPs to an Address Map — cloudflare.ip-address-management-address-maps-add-multiple-ips-to-an-address-map

Add multiple IPs to a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.ips array Required
body.ips[] — Optional $ref: "#/definitions/addressing_ip_address"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {
    "ips": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an IP from an Address Map — cloudflare.ip-address-management-address-maps-remove-an-ip-from-an-address-map

Remove an IP from a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip_address — Required $ref: "#/definitions/addressing_ip_address"
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip_address": "192.0.2.1",
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an IP to an Address Map — cloudflare.ip-address-management-address-maps-add-an-ip-to-an-address-map

Add an IP from a prefix owned by the account to a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip_address — Required $ref: "#/definitions/addressing_ip_address"
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip_address": "192.0.2.1",
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Multiple Zones from an Address Map — cloudflare.ip-address-management-address-maps-remove-multiple-zones-f-5db05ad215

Remove multiple zones as members of a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.zones array Required
body.zones[] — Optional $ref: "#/definitions/addressing_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {
    "zones": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Multiple Zones to an Address Map — cloudflare.ip-address-management-address-maps-add-multiple-zones-to-a-8db8398e99

Add multiple zones as members of a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.zones array Required
body.zones[] — Optional $ref: "#/definitions/addressing_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {
    "zones": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a zone membership from an Address Map — cloudflare.ip-address-management-address-maps-remove-a-zone-membershi-3d71ec9d92

Remove a zone as a member of a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.member_zone_id — Required $ref: "#/definitions/addressing_zone_identifier"
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "member_zone_id": "8ac8489932db6327334c9b6d58544cfe",
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a zone membership to an Address Map — cloudflare.ip-address-management-address-maps-add-a-zone-membership-t-bd46173fe2

Add a zone as a member of a particular address map.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.member_zone_id — Required $ref: "#/definitions/addressing_zone_identifier"
path.address_map_id — Required $ref: "#/definitions/addressing_address_map_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "member_zone_id": "8ac8489932db6327334c9b6d58544cfe",
    "address_map_id": "055817b111884e0227e1be16a0be6ee0",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Leases — cloudflare.ip-address-management-list-leases

List all leases owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List LOA Documents — cloudflare.ip-address-management-prefixes-list-loa-documents

List all LOA documents uploaded under the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Prefixes — cloudflare.ip-address-management-prefixes-list-prefixes

List all prefixes owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Prefix — cloudflare.ip-address-management-prefixes-add-prefix

Add a new prefix under the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.asn — Required $ref: "#/definitions/addressing_asn"
body.cidr — Required $ref: "#/definitions/addressing_cidr"
body.delegate_loa_creation — Optional $ref: "#/definitions/addressing_delegate_loa_creation"
body.description — Optional $ref: "#/definitions/addressing_description"
body.loa_document_id — Optional $ref: "#/definitions/addressing_loa_document_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {
    "cidr": "192.0.2.0/24",
    "asn": 13335
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Prefix — cloudflare.ip-address-management-prefixes-delete-prefix

Delete an unapproved prefix owned by the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Prefix Details — cloudflare.ip-address-management-prefixes-prefix-details

List a particular prefix owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Prefix Description — cloudflare.ip-address-management-prefixes-update-prefix-description

Modify the description for a prefix owned by the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.description — Required $ref: "#/definitions/addressing_description"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {
    "description": "Internal test prefix"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List BGP Prefixes — cloudflare.ip-address-management-prefixes-list-bgp-prefixes

List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create BGP Prefix — cloudflare.ip-address-management-prefixes-create-bgp-prefix

Create a BGP prefix, controlling the BGP advertisement status of a specific subnet. When created, BGP prefixes are initially withdrawn, and can be advertised with the Update BGP Prefix API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
body — Required $ref: "#/definitions/addressing_bgp_prefix_create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828"
  },
  "body": {
    "cidr": "192.0.2.0/24"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete BGP Prefix — cloudflare.ip-address-management-prefixes-delete-bgp-prefix

Delete a BGP Prefix associated with the specified IP Prefix. A BGP Prefix must be withdrawn before it can be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.bgp_prefix_id — Required $ref: "#/definitions/addressing_bgp_prefix_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "bgp_prefix_id": "7009ba364c7a5760798ceb430e603b74"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch BGP Prefix — cloudflare.ip-address-management-prefixes-fetch-bgp-prefix

Retrieve a single BGP Prefix according to its identifier

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.bgp_prefix_id — Required $ref: "#/definitions/addressing_bgp_prefix_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "bgp_prefix_id": "7009ba364c7a5760798ceb430e603b74"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update BGP Prefix — cloudflare.ip-address-management-prefixes-update-bgp-prefix

Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.bgp_prefix_id — Required $ref: "#/definitions/addressing_bgp_prefix_identifier"
body — Required $ref: "#/definitions/addressing_bgp_prefix_update_advertisement"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "bgp_prefix_id": "7009ba364c7a5760798ceb430e603b74"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Service Bindings — cloudflare.ip-address-management-service-bindings-list-service-bindings

List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address. Example: binding 192.0.2.0/24 to Cloudflare Magic Transit and 192.0.2.1/32 to the Cloudflare CDN would route traffic for 192.0.2.1 to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Service Binding — cloudflare.ip-address-management-service-bindings-create-service-binding

Creates a new Service Binding, routing traffic to IPs within the given CIDR to a service running on Cloudflare's network. NOTE: The first Service Binding created for an IP Prefix must exactly match the IP Prefix's CIDR. Subsequent Service Bindings may be created with a more-specific CIDR. Refer to the Service Bindings Documentation for compatibility details.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
body — Optional $ref: "#/definitions/addressing_create_binding_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Service Binding — cloudflare.ip-address-management-service-bindings-delete-service-binding

Delete a Service Binding

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.binding_id — Required $ref: "#/definitions/addressing_service_binding_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "binding_id": "0429b49b6a5155297b78e75a44b09e14"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Service Binding — cloudflare.ip-address-management-service-bindings-get-service-binding

Fetch a single Service Binding

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.binding_id — Required $ref: "#/definitions/addressing_service_binding_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "binding_id": "0429b49b6a5155297b78e75a44b09e14"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Prefix Delegations — cloudflare.ip-address-management-prefix-delegation-list-prefix-delegations

List all delegations for a given account IP prefix.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Prefix Delegation — cloudflare.ip-address-management-prefix-delegation-create-prefix-delegation

Create a new account delegation for a given IP prefix.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"
body object Required
body.cidr — Required $ref: "#/definitions/addressing_cidr"
body.delegated_account_id — Required $ref: "#/definitions/addressing_delegated_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  },
  "body": {
    "cidr": "192.0.2.0/24",
    "delegated_account_id": "b1946ac92492d2347c6235b4d2611184"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Prefix Delegation — cloudflare.ip-address-management-prefix-delegation-delete-prefix-delegation

Delete an account delegation for a given IP prefix.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.delegation_id — Required $ref: "#/definitions/addressing_delegation_identifier"
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "delegation_id": "d933b1530bc56c9953cf8ce166da8004",
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate Prefix — cloudflare.ip-address-management-prefixes-validate-prefix

Triggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.prefix_id — Required $ref: "#/definitions/addressing_prefix_identifier"
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "prefix_id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Regions — cloudflare.dls-account-regional-hostnames-list-regions

List all Regional Services regions available for use by this account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Services — cloudflare.ip-address-management-service-bindings-list-services

Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/addressing_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "258def64c72dae45f3e4c8516e2111f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get credit balance — cloudflare.aig-billing-get-credit-balance

Retrieve the current credit balance, payment method info, and top-up configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get invoice history — cloudflare.aig-billing-get-invoice-history

Retrieve a list of past invoices with pagination, optionally filtered by type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Optional additionalProperties: false
query.type string Optional Filter invoice type: auto, manual, or all. enum: ["auto","all","manual"]; default: "all"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get invoice preview — cloudflare.aig-billing-get-invoice-preview

Retrieve a preview of the upcoming invoice including line items and tax.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete spending limit (deprecated) — cloudflare.aig-billing-delete-spending-limit

Remove the spending limit for the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get spending limit (deprecated) — cloudflare.aig-billing-get-spending-limit

Retrieve the current spending limit configuration for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a top-up — cloudflare.aig-billing-create-topup

Create a credit top-up for the given account, charged to the account's default payment method. Requires a dashboard session; API token, OAuth, and service credentials receive 403.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Required additionalProperties: false
body.amount integer Required Top-up amount in cents (min 1000). minimum: 1000
body.payment_method_id string Optional Payment method to charge instead of the customer's default payment method.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "amount": 5000
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete auto top-up configuration — cloudflare.aig-billing-delete-topup-config

Remove the auto top-up configuration for the account. Dashboard sessions only: API token, OAuth, and service credentials are rejected with 403.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get auto top-up configuration — cloudflare.aig-billing-get-topup-config

Retrieve the current auto top-up threshold, amount, and any error state.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set auto top-up configuration — cloudflare.aig-billing-set-topup-config

Configure auto top-up with a balance threshold and top-up amount. Requests that add a payment method first return authentication details. The configuration is saved only after the authenticated setup is submitted. Dashboard sessions only: API token, OAuth, and service credentials are rejected with 403.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body — Required
body object Required anyOf[1]; additionalProperties: false
body.amount integer Required Auto top-up amount in cents (min 1000). anyOf[1]; minimum: 1000
body.threshold integer Required Balance threshold in cents that triggers auto top-up (min 500). anyOf[1]; minimum: 500
body object Required anyOf[2]; additionalProperties: false
body.amount integer Required Auto top-up amount in cents (min 1000). anyOf[2]; minimum: 1000
body.consent_version string Required Version of the off-session auto-top-up consent accepted by the user. anyOf[2]; minLength: 1; maxLength: 100
body.payment_method_id string Required Card to authenticate for future automatic top-ups. anyOf[2]
body.setup_idempotency_key string Required Client-generated UUID that makes payment-method setup safe to retry. anyOf[2]; format: "uuid"
body.setup_intent_id string Optional Successfully confirmed payment-method setup identifier. anyOf[2]
body.threshold integer Required Balance threshold in cents that triggers auto top-up (min 500). anyOf[2]; minimum: 500

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "threshold": 500,
    "amount": 5000
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top-up eligibility — cloudflare.aig-billing-topup-eligibility

Determine whether an account can self-serve a credit top-up, and if not, why. The dashboard forwards the account's payment-method list in the body; the reason logic is owned here.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Optional
body.payment_methods array Optional Account-level payment methods, forwarded by the dashboard. maxItems: 100
body.payment_methods[] object Optional
body.payment_methods[].default boolean Optional Whether this is the account default payment method.
body.payment_methods[].last_four string Optional Last 4 digits, for display copy only.
body.payment_methods[].type string Optional Payment-method type. Absent or unrecognized is treated as non-card (does not error). Known values: PAYPAL, CREDIT_CARD, APPLE_PAY, GOOGLE_PAY, ACH_DIRECT_DEBIT, SEPA_DEBIT, CASHAPP, LINK, CRYPTO.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account top-up limits — cloudflare.aig-billing-get-topup-limits

Retrieve the minimum and maximum allowed top-up amounts (in cents) for this account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check top-up status — cloudflare.aig-billing-check-topup-status

Get the payment processing status of a top-up by its top-up identifier.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Required additionalProperties: false
body.payment_intent_id string Required Top-up identifier to check status for.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "payment_intent_id": "in_1abc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get usage history — cloudflare.aig-billing-get-usage-history

Retrieve AI Gateway usage cost, in US dollars, aggregated by hour or day for the given time range.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Required additionalProperties: false
query.value_grouping_window string Required Grouping window for usage data. enum: ["day","hour"]
query.start_time number | null Optional Start time as Unix timestamp in milliseconds.
query.end_time number | null Optional End time as Unix timestamp in milliseconds.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "value_grouping_window": "day"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom providers — cloudflare.aig-config-list-account-provider

Lists the custom providers configured for the account, ordered by position and then name.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.beta boolean Optional
query.enable boolean Optional
query.search string Optional Search by id, name, slug

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom provider — cloudflare.aig-config-create-account-provider

Creates an account-level custom provider that forwards AI Gateway requests to the HTTPS base URL you supply. Requests reference the provider as custom-{slug}, so the slug must be unique within the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.base_url string Required format: "uri"
body.beta boolean Optional
body.curl_example string Optional
body.description string Optional
body.enable boolean Optional
body.headers string Optional JSON object of extra HTTP headers that AI Gateway sends to the provider. Values can contain credentials. maxLength: 8192
body.js_example string Optional
body.link string Optional
body.name string Required
body.position integer Optional
body.slug string Required pattern: "^[a-zA-Z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom provider pricing rules — cloudflare.aig-config-list-account-provider-cost

Lists the pricing rules for custom providers in the account, most recently modified first.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.enable boolean Optional
query.account_provider_id string Optional Only return pricing rules for this custom provider ID. format: "uuid"
query.model_rule string Optional enum: ["equals","starts-with","contains"]; default: "equals"
query.cost_type string Optional default: "tokens"
query.search string Optional Search by model, changed_by

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom provider pricing rule — cloudflare.aig-config-create-account-provider-cost

Creates a pricing rule that sets per-token costs for models matched on a custom provider. AI Gateway uses these rules to calculate request costs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.account_provider_id string Required ID of the custom provider that the pricing rule applies to. format: "uuid"
body.cost_in number Optional
body.cost_out number Optional
body.cost_type string Optional default: "tokens"
body.enable boolean Optional
body.model string Required
body.model_rule string Optional enum: ["equals","starts-with","contains"]; default: "equals"
body.token_pricing object Optional
body.token_pricing.input_audio_tokens number Optional
body.token_pricing.input_cache_creation_tokens number Optional
body.token_pricing.input_cached_tokens number Optional
body.token_pricing.input_image_count number Optional
body.token_pricing.input_image_tokens number Optional
body.token_pricing.input_text_tokens number Optional
body.token_pricing.input_tokens number Optional
body.token_pricing.input_video_tokens number Optional
body.token_pricing.output_image_count number Optional
body.token_pricing.output_reasoning_tokens number Optional
body.token_pricing.output_tokens number Optional
body.token_pricing.total_tokens number Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom provider pricing rule — cloudflare.aig-config-delete-account-provider-cost

Deletes a custom provider pricing rule. Requests to the matched model stop using its prices.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom provider pricing rule — cloudflare.aig-config-fetch-account-provider-cost

Retrieves a custom provider pricing rule, including its model match rule and token prices.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom provider pricing rule — cloudflare.aig-config-update-account-provider-cost

Updates the specified fields of a custom provider pricing rule. Changes clear cached costs for the matched model.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"
body object Optional
body.cost_in number Optional
body.cost_out number Optional
body.cost_type string Optional default: "tokens"
body.enable boolean Optional
body.model string Optional
body.model_rule string Optional enum: ["equals","starts-with","contains"]; default: "equals"
body.token_pricing object Optional
body.token_pricing.input_audio_tokens number Optional
body.token_pricing.input_cache_creation_tokens number Optional
body.token_pricing.input_cached_tokens number Optional
body.token_pricing.input_image_count number Optional
body.token_pricing.input_image_tokens number Optional
body.token_pricing.input_text_tokens number Optional
body.token_pricing.input_tokens number Optional
body.token_pricing.input_video_tokens number Optional
body.token_pricing.output_image_count number Optional
body.token_pricing.output_reasoning_tokens number Optional
body.token_pricing.output_tokens number Optional
body.token_pricing.total_tokens number Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom provider — cloudflare.aig-config-delete-account-provider

Deletes a custom provider and every pricing rule that belongs to it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom provider — cloudflare.aig-config-fetch-account-provider

Retrieves a custom provider, including its slug, base URL, and custom headers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom provider — cloudflare.aig-config-update-account-provider

Updates the specified fields of a custom provider. Changes clear cached entries for the provider.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"
body object Optional
body.base_url string Optional format: "uri"
body.beta boolean Optional
body.curl_example string Optional
body.description string Optional
body.enable boolean Optional
body.headers string Optional JSON object of extra HTTP headers that AI Gateway sends to the provider. Values can contain credentials. maxLength: 8192
body.js_example string Optional
body.link string Optional
body.logo string Optional
body.name string Optional
body.position integer Optional
body.slug string Optional pattern: "^[a-zA-Z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List evaluator types (deprecated) — cloudflare.aig-config-list-evaluators

Lists the evaluator types that evaluations can use to score AI Gateway responses. Evaluations are deprecated and unavailable to new accounts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 5; maximum: 50
query.order_by string Optional default: "mandatory"
query.order_by_direction string Optional enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List gateways — cloudflare.aig-config-list-gateway

Lists the AI Gateways in the account. Use search to filter by gateway ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.search string Optional Search by id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a gateway — cloudflare.aig-config-create-gateway

Creates an AI Gateway in the account with the specified caching, rate limiting, logging, and authentication settings. The gateway ID appears in request URLs and must be unique within the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.authentication boolean Optional Require authentication for gateway access. New gateways must have authentication enabled. Once enabled, authentication cannot be disabled.
body.byok_only boolean Optional Requires customer-provided provider credentials and prevents fallback to Unified Billing.
body.cache_invalidate_on_update boolean Required
body.cache_ttl integer | null Required minimum: 0
body.collect_logs boolean Required
body.dlp — Optional
body.dlp object Optional anyOf[1]
body.dlp.action string Required anyOf[1]; enum: ["BLOCK","FLAG"]
body.dlp.enabled boolean Required anyOf[1]
body.dlp.profiles array Required anyOf[1]
body.dlp.profiles[] string Optional anyOf[1]
body.dlp object Optional anyOf[2]
body.dlp.enabled boolean Required anyOf[2]
body.dlp.policies array Required anyOf[2]
body.dlp.policies[] object Optional anyOf[2]
body.dlp.policies[].action string Required anyOf[2]; enum: ["FLAG","BLOCK"]
body.dlp.policies[].check array Required anyOf[2]
body.dlp.policies[].check[] string Optional anyOf[2]; enum: ["REQUEST","RESPONSE"]
body.dlp.policies[].enabled boolean Required anyOf[2]
body.dlp.policies[].id string Required anyOf[2]
body.dlp.policies[].profiles array Required anyOf[2]
body.dlp.policies[].profiles[] string Optional anyOf[2]
body.guardrails object | null Optional
body.guardrails.prompt object Required
body.guardrails.prompt.P1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S10 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S11 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S12 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S13 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S14 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S2 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S3 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S4 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S5 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S6 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S7 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S8 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S9 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response object Required
body.guardrails.response.P1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S10 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S11 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S12 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S13 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S14 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S2 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S3 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S4 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S5 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S6 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S7 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S8 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S9 string Optional enum: ["FLAG","BLOCK"]
body.id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.log_classification boolean Optional
body.log_management integer | null Optional minimum: 10000; maximum: 10000000
body.log_management_strategy string | null Optional enum: ["STOP_INSERTING","DELETE_OLDEST"]
body.logpush boolean Optional
body.logpush_public_key string | null Optional minLength: 16; maxLength: 1024
body.otel array | null Optional maxItems: 5
body.otel[] object Optional
body.otel[].authorization string Optional maxLength: 256
body.otel[].content_type string Optional enum: ["json","protobuf"]; default: "json"
body.otel[].headers object Required additionalProperties: {"maxLength":4096,"type":"string"}
body.otel[].url string Required maxLength: 2048; format: "uri"
body.rate_limiting_interval integer | null Required minimum: 0
body.rate_limiting_limit integer | null Required minimum: 0
body.rate_limiting_technique string | null Optional enum: ["fixed","sliding"]
body.retry_backoff string | null Optional Backoff strategy for retry delays enum: ["constant","linear","exponential"]
body.retry_delay integer | null Optional Delay between retry attempts in milliseconds (0-60000) minimum: 0; maximum: 60000
body.retry_max_attempts integer | null Optional Maximum number of retry attempts for failed requests (1-5) minimum: 1; maximum: 5
body.spend_limits object | null Optional
body.spend_limits.enabled boolean Optional default: false
body.spend_limits.rules array Optional default: []; maxItems: 20
body.spend_limits.rules[] object Optional
body.spend_limits.rules[].enabled boolean Optional default: true
body.spend_limits.rules[].id string Optional default: "00000000"; minLength: 1; pattern: "^[a-zA-Z0-9_-]+$"
body.spend_limits.rules[].limit number Required exclusiveMinimum: 0
body.spend_limits.rules[].limitType string Required enum: ["cost"]
body.spend_limits.rules[].metadata object Optional additionalProperties: {"oneOf":[{"properties":{"mode":{"type":"string","enum":["partition"]}},"required":["mode"],"type":"object"},{"properties":{"mode":{"type":"string","enum":["filter"]},"values":{"type":"array","items":{"type":"string"}}},"required":["mode","values"],"type":"object"}]}
body.spend_limits.rules[].model object Optional
body.spend_limits.rules[].model.mode string Required enum: ["filter"]
body.spend_limits.rules[].model.values array Required
body.spend_limits.rules[].model.values[] string Optional
body.spend_limits.rules[].provider object Optional
body.spend_limits.rules[].provider.mode string Required enum: ["filter"]
body.spend_limits.rules[].provider.values array Required
body.spend_limits.rules[].provider.values[] string Optional
body.spend_limits.rules[].technique string Optional enum: ["fixed","sliding"]; default: "sliding"
body.spend_limits.rules[].window integer Required exclusiveMinimum: 0
body.store_id string | null Optional Secrets Store used by this gateway. Omit on update to keep the current store. Cannot be cleared while stored keys or secret references depend on it.
body.stripe object | null Optional
body.stripe.authorization string Required
body.stripe.usage_events array Required
body.stripe.usage_events[] object Optional
body.stripe.usage_events[].payload string Required
body.workers_ai_billing_mode string Optional Controls how Workers AI inference calls routed through this gateway are billed. 'postpaid' bills the account directly through Workers AI; 'unified' deducts credits via AI Gateway using neuron-based pricing and delegates billing to AI Gateway. enum: ["postpaid","unified"]; default: "postpaid"
body.zdr boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom domains — cloudflare.aig-config-list-custom-domain

Lists the custom domains attached to an AI Gateway, including the certificate and validation status of each domain.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.status string Optional enum: ["initializing","pending_dcv","active","blocked","error"]
query.search string Optional Search by hostname

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom domain for a gateway — cloudflare.aig-config-create-custom-domain

Provisions a Cloudflare-for-SaaS custom hostname and returns the CNAME target to point DNS at.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body object Optional
body.domain string Required Custom hostname that you own, such as ai.example.com. minLength: 1; maxLength: 253; pattern: "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)+$"
body.minTLS string Optional enum: ["1.0","1.1","1.2","1.3"]
body.zone_id string Required ID of the Cloudflare zone that contains the custom hostname. pattern: "^[0-9a-f]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom domain — cloudflare.aig-config-delete-custom-domain

Deletes a custom domain from an AI Gateway and removes its Cloudflare for SaaS custom hostname.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.hostname string Required Custom hostname that you own, such as ai.example.com. minLength: 1; maxLength: 253; pattern: "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "hostname": "ai.acme.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom domain — cloudflare.aig-config-fetch-custom-domain

Retrieves a custom domain attached to an AI Gateway, including its status and CNAME target.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.hostname string Required Custom hostname that you own, such as ai.example.com. minLength: 1; maxLength: 253; pattern: "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "hostname": "ai.acme.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List datasets (deprecated) — cloudflare.aig-config-list-dataset

Lists the datasets defined for an AI Gateway. Evaluations and datasets are deprecated and unavailable to new accounts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.name string Optional
query.enable boolean Optional
query.search string Optional Search by id, name, filters

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a dataset (deprecated) — cloudflare.aig-config-create-dataset

Creates a dataset that selects gateway logs matching the specified filters for use in evaluations. Evaluations and datasets are deprecated and unavailable to new accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
body object Optional
body.enable boolean Required
body.filters array Required
body.filters[] object Optional
body.filters[].key string Required enum: ["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"]
body.filters[].operator string Required enum: ["eq","contains","lt","gt"]
body.filters[].value array Required
body.filters[].value[] — Optional
body.filters[].value[] string Optional anyOf[1]
body.filters[].value[] number Optional anyOf[2]
body.filters[].value[] boolean Optional anyOf[3]
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gateway_id": "my-gateway",
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a dataset (deprecated) — cloudflare.aig-config-delete-dataset

Deletes a dataset. Evaluations and datasets are deprecated and unavailable to new accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a dataset (deprecated) — cloudflare.aig-config-fetch-dataset

Retrieves a dataset and its log filters. Evaluations and datasets are deprecated and unavailable to new accounts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a dataset (deprecated) — cloudflare.aig-config-update-dataset

Replaces the name, log filters, and enabled state of a dataset. Evaluations and datasets are deprecated and unavailable to new accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required
body object Optional
body.enable boolean Required
body.filters array Required
body.filters[] object Optional
body.filters[].key string Required enum: ["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"]
body.filters[].operator string Required enum: ["eq","contains","lt","gt"]
body.filters[].value array Required
body.filters[].value[] — Optional
body.filters[].value[] string Optional anyOf[1]
body.filters[].value[] number Optional anyOf[2]
body.filters[].value[] boolean Optional anyOf[3]
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List evaluations (deprecated) — cloudflare.aig-config-list-evaluations

Lists the evaluations run on an AI Gateway. Evaluations and datasets are deprecated and unavailable to new accounts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.name string Optional
query.processed boolean Optional
query.search string Optional Search by id, name

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an evaluation (deprecated) — cloudflare.aig-config-create-evaluations

Creates an evaluation that scores the logs in a dataset with the specified evaluator types. Evaluations and datasets are deprecated and unavailable to new accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
body object Optional
body.dataset_ids array Required minItems: 1; maxItems: 5
body.dataset_ids[] string Optional
body.evaluation_type_ids array Required
body.evaluation_type_ids[] string Optional
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gateway_id": "my-gateway",
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an evaluation (deprecated) — cloudflare.aig-config-delete-evaluations

Deletes an evaluation and its results. Evaluations and datasets are deprecated and unavailable to new accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an evaluation (deprecated) — cloudflare.aig-config-fetch-evaluations

Retrieves an evaluation and its results. Evaluations and datasets are deprecated and unavailable to new accounts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Gateway Logs — cloudflare.aig-config-delete-gateway-logs

Deletes gateway log entries matching the specified criteria.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
query object Optional additionalProperties: false
query.order_by string Optional enum: ["created_at","provider","model","model_type","success","cached","cost","tokens_in","tokens_out","duration","feedback"]; default: "created_at"
query.order_by_direction string Optional enum: ["asc","desc"]; default: "asc"
query.filters array Optional
query.filters[] object Optional
query.filters[].key string Required enum: ["id","created_at","request_content_type","response_content_type","request_type","success","cached","provider","model","model_type","cost","tokens","tokens_in","tokens_out","duration","feedback","event_id","metadata.key","metadata.value","authentication","wholesale","compatibilityMode","dlp_action","user_agent"]
query.filters[].operator string Required enum: ["eq","neq","contains","lt","gt"]
query.filters[].value array Required Filter values.
query.filters[].value[] — Optional
query.filters[].value[] string | null Optional anyOf[1]
query.filters[].value[] number Optional anyOf[2]
query.filters[].value[] boolean Optional anyOf[3]
query.limit integer Optional default: 10000; minimum: 1; maximum: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Gateway Logs — cloudflare.aig-config-list-gateway-logs

Lists request/response log entries for the AI gateway with filtering and pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
query object Optional additionalProperties: false
query.search string Optional Free-text search over log metadata.
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 50
query.order_by string Optional enum: ["created_at","provider","model","model_type","success","cached"]; default: "created_at"
query.order_by_direction string Optional enum: ["asc","desc"]; default: "desc"
query.filters array Optional
query.filters[] object Optional
query.filters[].key string Required enum: ["id","created_at","request_content_type","response_content_type","request_type","success","cached","provider","model","model_type","cost","tokens","tokens_in","tokens_out","duration","feedback","event_id","metadata.key","metadata.value","authentication","wholesale","compatibilityMode","dlp_action","user_agent"]
query.filters[].operator string Required enum: ["eq","neq","contains","lt","gt"]
query.filters[].value array Required Filter values.
query.filters[].value[] — Optional
query.filters[].value[] string | null Optional anyOf[1]
query.filters[].value[] number Optional anyOf[2]
query.filters[].value[] boolean Optional anyOf[3]
query.meta_info boolean Optional
query.direction string Optional enum: ["asc","desc"]
query.start_date string Optional format: "date-time"
query.end_date string Optional format: "date-time"
query.min_cost number Optional
query.max_cost number Optional
query.min_tokens_in number Optional
query.max_tokens_in number Optional
query.min_tokens_out number Optional
query.max_tokens_out number Optional
query.min_total_tokens number Optional
query.max_total_tokens number Optional
query.min_duration number Optional
query.max_duration number Optional
query.feedback — Optional
query.feedback number Optional anyOf[1]; enum: [-1]
query.feedback number Optional anyOf[2]; enum: [0]
query.feedback number Optional anyOf[3]; enum: [1]
query.success boolean Optional
query.cached boolean Optional
query.model string Optional Model filter.
query.model_type string Optional
query.provider string Optional
query.request_content_type string Optional
query.response_content_type string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Gateway Log Detail — cloudflare.aig-config-get-gateway-log-detail

Retrieves detailed information for a specific AI Gateway log entry.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example",
    "gateway_id": "my-gateway",
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Gateway Log — cloudflare.aig-config-patch-gateway-log

Updates metadata for an AI Gateway log entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
body object Optional
body.feedback number | null Optional minimum: -1; maximum: 1
body.metadata object | null Optional additionalProperties: {"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}
body.score number | null Optional minimum: 0; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example",
    "gateway_id": "my-gateway",
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Gateway Log Request — cloudflare.aig-config-get-gateway-log-request

Retrieves the original request payload for an AI Gateway log entry.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example",
    "gateway_id": "my-gateway",
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Gateway Log Response — cloudflare.aig-config-get-gateway-log-response

Retrieves the response payload for an AI Gateway log entry.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example",
    "gateway_id": "my-gateway",
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List provider keys — cloudflare.aig-config-list-providers

Lists the provider keys stored for an AI Gateway. Responses show a masked preview of each key, never the key itself.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Store a provider key — cloudflare.aig-config-create-providers

Stores an upstream AI provider API key for an AI Gateway in the Secrets Store configured on the gateway, with an optional rate limit. Pass secret to store a new key, or omit it to use an existing Secrets Store secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body object Optional
body.alias string Required
body.default_config boolean Required
body.provider_slug string Required
body.rate_limit number Optional
body.rate_limit_period number Optional default: 60
body.secret string Optional Provider API key to store in the Secrets Store configured on the gateway.
body.secret_id string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a provider key — cloudflare.aig-config-delete-providers

Deletes a provider key configuration from an AI Gateway and deletes its secret from the Secrets Store.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a provider key — cloudflare.aig-config-fetch-providers

Retrieves a provider key configuration for an AI Gateway. The response shows a masked preview of the key, never the key itself.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate a provider key — cloudflare.aig-config-update-providers

Replaces the stored API key of a provider key configuration. Only the key can change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.id string Required
body object Optional
body.secret string Required Provider API key to store in the Secrets Store configured on the gateway.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "gateway_id": "my-gateway",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List dynamic routes — cloudflare.aig-config-list-gateway-dynamic-routes

Lists the dynamic routes configured on an AI Gateway.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
query object Optional additionalProperties: false
query.page integer Optional Page number
query.per_page integer Optional Number of routes per page

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a dynamic route — cloudflare.aig-config-post-gateway-dynamic-route

Creates a dynamic route on an AI Gateway from the specified routing elements. Clients call the route by using dynamic/{name} as the model name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
body object Optional
body.elements array Required
body.elements[] — Optional
body.elements[] object Optional oneOf[1]
body.elements[].id string Required oneOf[1]
body.elements[].outputs object Required oneOf[1]
body.elements[].outputs.next object Required oneOf[1]
body.elements[].outputs.next.elementId string Required oneOf[1]
body.elements[].type string Required oneOf[1]; enum: ["start"]
body.elements[] object Optional oneOf[2]
body.elements[].id string Required oneOf[2]
body.elements[].outputs object Required oneOf[2]
body.elements[].outputs.false object Required oneOf[2]
body.elements[].outputs.false.elementId string Required oneOf[2]
body.elements[].outputs.true object Required oneOf[2]
body.elements[].outputs.true.elementId string Required oneOf[2]
body.elements[].properties object Required oneOf[2]
body.elements[].properties.conditions object Optional oneOf[2]
body.elements[].type string Required oneOf[2]; enum: ["conditional"]
body.elements[] object Optional oneOf[3]
body.elements[].id string Required oneOf[3]
body.elements[].outputs object Required oneOf[3]; additionalProperties: {"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}
body.elements[].type string Required oneOf[3]; enum: ["percentage"]
body.elements[] object Optional oneOf[4]
body.elements[].id string Required oneOf[4]
body.elements[].outputs object Required oneOf[4]
body.elements[].outputs.fallback object Required oneOf[4]
body.elements[].outputs.fallback.elementId string Required oneOf[4]
body.elements[].outputs.success object Required oneOf[4]
body.elements[].outputs.success.elementId string Required oneOf[4]
body.elements[].properties object Required oneOf[4]
body.elements[].properties.key string Required oneOf[4]
body.elements[].properties.limit number Required oneOf[4]
body.elements[].properties.limitType string Required oneOf[4]; enum: ["count","cost"]
body.elements[].properties.window number Required oneOf[4]
body.elements[].type string Required oneOf[4]; enum: ["rate"]
body.elements[] object Optional oneOf[5]
body.elements[].id string Required oneOf[5]
body.elements[].outputs object Required oneOf[5]
body.elements[].outputs.fallback object Required oneOf[5]
body.elements[].outputs.fallback.elementId string Required oneOf[5]
body.elements[].outputs.success object Required oneOf[5]
body.elements[].outputs.success.elementId string Required oneOf[5]
body.elements[].properties object Required oneOf[5]
body.elements[].properties.model string Required oneOf[5]
body.elements[].properties.provider string Required oneOf[5]
body.elements[].properties.retries number Required oneOf[5]
body.elements[].properties.timeout number Required oneOf[5]
body.elements[].type string Required oneOf[5]; enum: ["model"]
body.elements[] object Optional oneOf[6]
body.elements[].id string Required oneOf[6]
body.elements[].outputs object Required oneOf[6]; additionalProperties: {"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}
body.elements[].type string Required oneOf[6]; enum: ["end"]
body.name string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a dynamic route — cloudflare.aig-config-delete-gateway-dynamic-route

Deletes a dynamic route from an AI Gateway.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a dynamic route — cloudflare.aig-config-get-gateway-dynamic-route

Retrieves a dynamic route with its routing elements, active version, and current deployment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rename a dynamic route — cloudflare.aig-config-update-gateway-dynamic-route

Updates the name of a dynamic route. To change routing behaviour, create and deploy a new version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required
body object Optional
body.name string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List dynamic route deployments — cloudflare.aig-config-list-gateway-dynamic-route-deployments

Lists the deployment history of a dynamic route.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deploy a dynamic route version — cloudflare.aig-config-post-gateway-dynamic-route-deployment

Deploys the specified version of a dynamic route so that it serves traffic. Deploy an earlier version to roll back.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required
body object Optional
body.version_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List dynamic route versions — cloudflare.aig-config-list-gateway-dynamic-route-versions

Lists the saved versions of a dynamic route.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a dynamic route version — cloudflare.aig-config-post-gateway-dynamic-route-version

Creates a new version of a dynamic route from the specified routing elements. The version does not serve traffic until you deploy it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required
body object Optional
body.elements array Required
body.elements[] — Optional
body.elements[] object Optional oneOf[1]
body.elements[].id string Required oneOf[1]
body.elements[].outputs object Required oneOf[1]
body.elements[].outputs.next object Required oneOf[1]
body.elements[].outputs.next.elementId string Required oneOf[1]
body.elements[].type string Required oneOf[1]; enum: ["start"]
body.elements[] object Optional oneOf[2]
body.elements[].id string Required oneOf[2]
body.elements[].outputs object Required oneOf[2]
body.elements[].outputs.false object Required oneOf[2]
body.elements[].outputs.false.elementId string Required oneOf[2]
body.elements[].outputs.true object Required oneOf[2]
body.elements[].outputs.true.elementId string Required oneOf[2]
body.elements[].properties object Required oneOf[2]
body.elements[].properties.conditions object Optional oneOf[2]
body.elements[].type string Required oneOf[2]; enum: ["conditional"]
body.elements[] object Optional oneOf[3]
body.elements[].id string Required oneOf[3]
body.elements[].outputs object Required oneOf[3]; additionalProperties: {"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}
body.elements[].type string Required oneOf[3]; enum: ["percentage"]
body.elements[] object Optional oneOf[4]
body.elements[].id string Required oneOf[4]
body.elements[].outputs object Required oneOf[4]
body.elements[].outputs.fallback object Required oneOf[4]
body.elements[].outputs.fallback.elementId string Required oneOf[4]
body.elements[].outputs.success object Required oneOf[4]
body.elements[].outputs.success.elementId string Required oneOf[4]
body.elements[].properties object Required oneOf[4]
body.elements[].properties.key string Required oneOf[4]
body.elements[].properties.limit number Required oneOf[4]
body.elements[].properties.limitType string Required oneOf[4]; enum: ["count","cost"]
body.elements[].properties.window number Required oneOf[4]
body.elements[].type string Required oneOf[4]; enum: ["rate"]
body.elements[] object Optional oneOf[5]
body.elements[].id string Required oneOf[5]
body.elements[].outputs object Required oneOf[5]
body.elements[].outputs.fallback object Required oneOf[5]
body.elements[].outputs.fallback.elementId string Required oneOf[5]
body.elements[].outputs.success object Required oneOf[5]
body.elements[].outputs.success.elementId string Required oneOf[5]
body.elements[].properties object Required oneOf[5]
body.elements[].properties.model string Required oneOf[5]
body.elements[].properties.provider string Required oneOf[5]
body.elements[].properties.retries number Required oneOf[5]
body.elements[].properties.timeout number Required oneOf[5]
body.elements[].type string Required oneOf[5]; enum: ["model"]
body.elements[] object Optional oneOf[6]
body.elements[].id string Required oneOf[6]
body.elements[].outputs object Required oneOf[6]; additionalProperties: {"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}
body.elements[].type string Required oneOf[6]; enum: ["end"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a dynamic route version — cloudflare.aig-config-get-gateway-dynamic-route-version

Retrieves a saved version of a dynamic route, including its routing elements.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.gateway_id string Required
path.id string Required
path.version_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "gateway_id": "54442216",
    "id": "54442216",
    "version_id": "54442216"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Gateway URL — cloudflare.aig-config-get-gateway-url

Retrieves the endpoint URL for an AI Gateway.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gateway_id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
path.provider string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gateway_id": "my-gateway",
    "account_id": "0d37909e38d3e99c29fa2cd343ac421a",
    "provider": "workers-ai"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a gateway — cloudflare.aig-config-delete-gateway

Permanently deletes an AI Gateway, its configuration, and its stored logs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a gateway — cloudflare.aig-config-fetch-gateway

Retrieves the configuration of an AI Gateway.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a gateway — cloudflare.aig-config-update-gateway

Updates the configuration of an AI Gateway, such as its caching, rate limiting, logging, and authentication settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required Unique identifier of the AI Gateway within the account. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body object Optional
body.authentication boolean Optional Require authentication for gateway access. New gateways must have authentication enabled. Once enabled, authentication cannot be disabled.
body.byok_only boolean Optional Requires customer-provided provider credentials and prevents fallback to Unified Billing.
body.cache_invalidate_on_update boolean Required
body.cache_ttl integer | null Required minimum: 0
body.collect_logs boolean Required
body.dlp — Optional
body.dlp object Optional anyOf[1]
body.dlp.action string Required anyOf[1]; enum: ["BLOCK","FLAG"]
body.dlp.enabled boolean Required anyOf[1]
body.dlp.profiles array Required anyOf[1]
body.dlp.profiles[] string Optional anyOf[1]
body.dlp object Optional anyOf[2]
body.dlp.enabled boolean Required anyOf[2]
body.dlp.policies array Required anyOf[2]
body.dlp.policies[] object Optional anyOf[2]
body.dlp.policies[].action string Required anyOf[2]; enum: ["FLAG","BLOCK"]
body.dlp.policies[].check array Required anyOf[2]
body.dlp.policies[].check[] string Optional anyOf[2]; enum: ["REQUEST","RESPONSE"]
body.dlp.policies[].enabled boolean Required anyOf[2]
body.dlp.policies[].id string Required anyOf[2]
body.dlp.policies[].profiles array Required anyOf[2]
body.dlp.policies[].profiles[] string Optional anyOf[2]
body.guardrails object | null Optional
body.guardrails.prompt object Required
body.guardrails.prompt.P1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S10 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S11 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S12 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S13 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S14 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S2 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S3 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S4 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S5 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S6 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S7 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S8 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.prompt.S9 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response object Required
body.guardrails.response.P1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S1 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S10 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S11 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S12 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S13 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S14 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S2 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S3 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S4 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S5 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S6 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S7 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S8 string Optional enum: ["FLAG","BLOCK"]
body.guardrails.response.S9 string Optional enum: ["FLAG","BLOCK"]
body.log_classification boolean Optional
body.log_management integer | null Optional minimum: 10000; maximum: 10000000
body.log_management_strategy string | null Optional enum: ["STOP_INSERTING","DELETE_OLDEST"]
body.logpush boolean Optional
body.logpush_public_key string | null Optional minLength: 16; maxLength: 1024
body.otel array | null Optional maxItems: 5
body.otel[] object Optional
body.otel[].authorization string Optional maxLength: 256
body.otel[].content_type string Optional enum: ["json","protobuf"]; default: "json"
body.otel[].headers object Required additionalProperties: {"maxLength":4096,"type":"string"}
body.otel[].url string Required maxLength: 2048; format: "uri"
body.rate_limiting_interval integer | null Required minimum: 0
body.rate_limiting_limit integer | null Required minimum: 0
body.rate_limiting_technique string | null Optional enum: ["fixed","sliding"]
body.retry_backoff string | null Optional Backoff strategy for retry delays enum: ["constant","linear","exponential"]
body.retry_delay integer | null Optional Delay between retry attempts in milliseconds (0-60000) minimum: 0; maximum: 60000
body.retry_max_attempts integer | null Optional Maximum number of retry attempts for failed requests (1-5) minimum: 1; maximum: 5
body.spend_limits object | null Optional
body.spend_limits.enabled boolean Optional default: false
body.spend_limits.rules array Optional default: []; maxItems: 20
body.spend_limits.rules[] object Optional
body.spend_limits.rules[].enabled boolean Optional default: true
body.spend_limits.rules[].id string Optional default: "00000000"; minLength: 1; pattern: "^[a-zA-Z0-9_-]+$"
body.spend_limits.rules[].limit number Required exclusiveMinimum: 0
body.spend_limits.rules[].limitType string Required enum: ["cost"]
body.spend_limits.rules[].metadata object Optional additionalProperties: {"oneOf":[{"properties":{"mode":{"type":"string","enum":["partition"]}},"required":["mode"],"type":"object"},{"properties":{"mode":{"type":"string","enum":["filter"]},"values":{"type":"array","items":{"type":"string"}}},"required":["mode","values"],"type":"object"}]}
body.spend_limits.rules[].model object Optional
body.spend_limits.rules[].model.mode string Required enum: ["filter"]
body.spend_limits.rules[].model.values array Required
body.spend_limits.rules[].model.values[] string Optional
body.spend_limits.rules[].provider object Optional
body.spend_limits.rules[].provider.mode string Required enum: ["filter"]
body.spend_limits.rules[].provider.values array Required
body.spend_limits.rules[].provider.values[] string Optional
body.spend_limits.rules[].technique string Optional enum: ["fixed","sliding"]; default: "sliding"
body.spend_limits.rules[].window integer Required exclusiveMinimum: 0
body.store_id string | null Optional Secrets Store used by this gateway. Omit on update to keep the current store. Cannot be cleared while stored keys or secret references depend on it.
body.stripe object | null Optional
body.stripe.authorization string Required
body.stripe.usage_events array Required
body.stripe.usage_events[] object Optional
body.stripe.usage_events[].payload string Required
body.workers_ai_billing_mode string Optional Controls how Workers AI inference calls routed through this gateway are billed. 'postpaid' bills the account directly through Workers AI; 'unified' deducts credits via AI Gateway using neuron-based pricing and delegates billing to AI Gateway. enum: ["postpaid","unified"]; default: "postpaid"
body.zdr boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "3ebbcb006d4d46d7bb6a8c7f14676cb0",
    "id": "my-gateway"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AI Gateway logging state — cloudflare.aig-config-get-logging-state

Returns the canonical logging platform and migration availability for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Migrate AI Gateway logging to Workers Observability — cloudflare.aig-config-patch-logging-state

Irreversibly migrates an eligible account to Workers Observability logging.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List namespaces — cloudflare.ai-search-list-namespaces

Lists namespaces in the account, including their descriptions and creation times.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional Page number (1-indexed). default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 20; minimum: 1; maximum: 100
query.search string Optional Filter namespaces whose name or description contains this string (case-insensitive). maxLength: 256

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a namespace — cloudflare.ai-search-create-namespace

Create a namespace for organizing AI Search instances.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.description string | null Optional Optional description for the namespace. Max 256 characters. maxLength: 256
body.name string Required pattern: "^[a-z0-9]([a-z0-9-]{0,26}[a-z0-9])?$"
body.public_endpoint_params object Optional
body.public_endpoint_params.authorized_hosts array Optional
body.public_endpoint_params.authorized_hosts[] string Optional
body.public_endpoint_params.chat_completions_endpoint object Optional
body.public_endpoint_params.chat_completions_endpoint.disabled boolean Optional Disable chat completions endpoint for this public endpoint. default: false
body.public_endpoint_params.custom_domains array | null Optional Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). maxItems: 1
body.public_endpoint_params.custom_domains[] string Optional Custom domain hostname. Must belong to a Verified zone on this account. minLength: 1; maxLength: 253
body.public_endpoint_params.default_domain_enabled boolean Optional When false, the instance is reachable only via a registered custom domain and the default <public_endpoint_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public_endpoint_params is replaced wholesale on update, so resend default_domain_enabled on every update to keep the default host off — omitting it resets to true. default: true
body.public_endpoint_params.enabled boolean Optional default: false
body.public_endpoint_params.instances_allowed array Optional Instance IDs exposed through the namespace public endpoint. Empty means nothing is searchable. Every ID must reference an existing instance in this namespace, and the list must stay within the account's multi-instance search limit. default: []; maxItems: 10
body.public_endpoint_params.instances_allowed[] string Optional AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.public_endpoint_params.mcp object Optional
body.public_endpoint_params.mcp.description string Optional default: "Finds exactly what you're looking for"
body.public_endpoint_params.mcp.disabled boolean Optional Disable MCP endpoint for this public endpoint. default: false
body.public_endpoint_params.rate_limit object Optional
body.public_endpoint_params.rate_limit.period_ms integer Optional minimum: 60000; maximum: 3600000
body.public_endpoint_params.rate_limit.requests integer Optional minimum: 1
body.public_endpoint_params.rate_limit.technique string Optional enum: ["fixed","sliding"]
body.public_endpoint_params.search_endpoint object Optional
body.public_endpoint_params.search_endpoint.disabled boolean Optional Disable search endpoint for this public endpoint. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List AI Search instances. — cloudflare.ai-search-namespace-list-instances

Lists all AI Search instances in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
query object Optional additionalProperties: false
query.page integer Optional Page number (1-indexed). default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 20; minimum: 1; maximum: 100
query.search string Optional Filter instances whose id contains this string (case-insensitive). maxLength: 64
query.hostname string Optional Return only instances with this exact Search for Agents hostname (case-insensitive). minLength: 1; maxLength: 253
query.order_by string Optional Field to order results by. enum: ["created_at"]; default: "created_at"
query.order_by_direction string Optional Order direction. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an AI Search instance. — cloudflare.ai-search-namespace-create-instance

Create a new AI Search instance with the given configuration. If type is omitted or null, a non-blank HTTP(S) source infers web-crawler and any other source infers r2; r2 sources must name an existing bucket. A missing or blank source without a type creates a managed upload-only instance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
body object Optional
body.ai_gateway_id string | null Optional
body.ai_search_model string | null Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.cache boolean Optional default: true
body.cache_threshold string Optional enum: ["super_strict_match","close_enough","flexible_friend","anything_goes"]; default: "close_enough"
body.cache_ttl — Optional Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). default: 172800
body.cache_ttl number Optional anyOf[1]; enum: [600]
body.cache_ttl number Optional anyOf[2]; enum: [1800]
body.cache_ttl number Optional anyOf[3]; enum: [3600]
body.cache_ttl number Optional anyOf[4]; enum: [7200]
body.cache_ttl number Optional anyOf[5]; enum: [21600]
body.cache_ttl number Optional anyOf[6]; enum: [43200]
body.cache_ttl number Optional anyOf[7]; enum: [86400]
body.cache_ttl number Optional anyOf[8]; enum: [172800]
body.cache_ttl number Optional anyOf[9]; enum: [259200]
body.cache_ttl number Optional anyOf[10]; enum: [518400]
body.chunk boolean Optional default: true
body.chunk_overlap integer Optional default: 10; minimum: 0; maximum: 30
body.chunk_size integer Optional minimum: 64
body.custom_metadata array Optional maxItems: 5
body.custom_metadata[] object Optional
body.custom_metadata[].data_type string Required enum: ["text","number","boolean","datetime"]
body.custom_metadata[].field_name string Required minLength: 1; maxLength: 64
body.embedding_model string | null Optional
body.fusion_method string Optional enum: ["max","rrf"]; default: "rrf"
body.hybrid_search_enabled boolean Optional Deprecated — use index_method instead. Defaults to true for new instances; set false to create a vector-only instance.
body.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.index_method object Optional Controls which storage backends indexing uses. Defaults to vector and keyword indexing for new instances. When set, both vector and keyword are required.
body.index_method.keyword boolean Required Enable keyword (BM25) storage backend.
body.index_method.vector boolean Required Enable vector (embedding) storage backend.
body.indexing_options object | null Optional
body.indexing_options.keyword_tokenizer string Optional Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. enum: ["porter","trigram"]; default: "porter"
body.indexing_options.use_ocr boolean Optional Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. default: false
body.max_num_results integer Optional default: 10; minimum: 1; maximum: 50
body.metadata object Optional
body.metadata.created_from_aisearch_wizard boolean Optional
body.metadata.created_from_emdash_plugin object Optional additionalProperties: true
body.metadata.created_from_emdash_plugin.type string Required enum: ["native","rest"]
body.metadata.created_from_emdash_plugin.version string Required
body.metadata.worker_domain string Optional
body.public_endpoint_params object Optional
body.public_endpoint_params.authorized_hosts array Optional
body.public_endpoint_params.authorized_hosts[] string Optional
body.public_endpoint_params.chat_completions_endpoint object Optional
body.public_endpoint_params.chat_completions_endpoint.disabled boolean Optional Disable chat completions endpoint for this public endpoint. default: false
body.public_endpoint_params.custom_domains array | null Optional Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). maxItems: 1
body.public_endpoint_params.custom_domains[] string Optional Custom domain hostname. Must belong to a Verified zone on this account. minLength: 1; maxLength: 253
body.public_endpoint_params.default_domain_enabled boolean Optional When false, the instance is reachable only via a registered custom domain and the default <public_endpoint_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public_endpoint_params is replaced wholesale on update, so resend default_domain_enabled on every update to keep the default host off — omitting it resets to true. default: true
body.public_endpoint_params.enabled boolean Optional default: false
body.public_endpoint_params.mcp object Optional
body.public_endpoint_params.mcp.description string Optional default: "Finds exactly what you're looking for"
body.public_endpoint_params.mcp.disabled boolean Optional Disable MCP endpoint for this public endpoint. default: false
body.public_endpoint_params.rate_limit object Optional
body.public_endpoint_params.rate_limit.period_ms integer Optional minimum: 60000; maximum: 3600000
body.public_endpoint_params.rate_limit.requests integer Optional minimum: 1
body.public_endpoint_params.rate_limit.technique string Optional enum: ["fixed","sliding"]
body.public_endpoint_params.search_endpoint object Optional
body.public_endpoint_params.search_endpoint.disabled boolean Optional Disable search endpoint for this public endpoint. default: false
body.reranking boolean Optional default: false
body.reranking_model string | null Optional
body.retrieval_options object | null Optional
body.retrieval_options.boost_by array Optional Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric/datetime fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. maxItems: 3
body.retrieval_options.boost_by[] object Optional
body.retrieval_options.boost_by[].direction string Optional Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. enum: ["asc","desc","exists","not_exists"]
body.retrieval_options.boost_by[].field string Required Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not_exists); text/boolean fields only support exists/not_exists. minLength: 1; maxLength: 64
body.retrieval_options.keyword_match_mode string Optional Controls which documents become candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term and ranks results according to BM25 relevance. When omitted on an update, the existing stored value stays unchanged; when never set, search falls back to 'and'. enum: ["and","or"]
body.rewrite_model string | null Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.rewrite_query boolean Optional default: false
body.score_threshold number Optional Minimum similarity score a chunk must reach to be returned. Defaults to 0.4. minimum: 0; maximum: 1
body.source string | null Optional
body.source_params object | null Optional
body.source_params.exclude_items array Optional List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced). Most accounts have a limit of 10 rules; contact support to raise it. maxItems: 10
body.source_params.exclude_items[] string Optional maxLength: 500; pattern: "^[*/\\\\]?[\\w\\-/.\\\\?*:=&%]+$"
body.source_params.include_items array Optional List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post). Most accounts have a limit of 10 rules; contact support to raise it. maxItems: 10
body.source_params.include_items[] string Optional maxLength: 500; pattern: "^[*/\\\\]?[\\w\\-/.\\\\?*:=&%]+$"
body.source_params.prefix string Optional
body.source_params.r2_jurisdiction string Optional default: "default"
body.source_params.web_crawler object Optional default: {"parse_type":"sitemap"}
body.source_params.web_crawler.discover_options object Optional Options for parse_type 'discover', where Browser Run discovers URLs through link following and sitemaps. Ignored for 'sitemap'.
body.source_params.web_crawler.discover_options.depth number Optional Maximum link-follow depth from the seed URL. default: 5; minimum: 1; maximum: 100000
body.source_params.web_crawler.discover_options.include_external_links boolean Optional Follow links that point outside the source domain. Must stay false because discover crawls only cover the zone you own. default: false
body.source_params.web_crawler.discover_options.include_subdomains boolean Optional Follow links to subdomains of the source host. default: false
body.source_params.web_crawler.discover_options.limit number Optional Maximum number of pages to crawl (1-100000). default: 100000; minimum: 1; maximum: 100000
body.source_params.web_crawler.discover_options.max_age number Optional Maximum content age in seconds to accept (0–604800). default: 86400; minimum: 0; maximum: 604800
body.source_params.web_crawler.discover_options.source string Optional Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. enum: ["all","sitemaps","links"]; default: "all"
body.source_params.web_crawler.parse_options object Optional
body.source_params.web_crawler.parse_options.content_selector array Optional List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. The crawler stores and indexes only the matched HTML fragment. Omit the field to disable content selection; the API rejects empty arrays. minItems: 1; maxItems: 10
body.source_params.web_crawler.parse_options.content_selector[] object Optional
body.source_params.web_crawler.parse_options.content_selector[].path string Required Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories. minLength: 1; maxLength: 200
body.source_params.web_crawler.parse_options.content_selector[].selector string Required CSS selector to extract content from pages matching the path pattern. Disallowed characters: ;, `, $, {, }, . Must target a single element; if multiple elements match, the crawler ignores the selector and uses the full page. minLength: 1; maxLength: 200
body.source_params.web_crawler.parse_options.include_headers object Optional Up to 5 custom HTTP headers sent with each crawl request. Names must use RFC-7230 token characters, excluding spaces, colons, and control characters. Values must use HTAB and printable ASCII only, excluding CR and LF. additionalProperties: {"maxLength":8192,"pattern":"^[\\t\\x20-\\x7E]*$","type":"string"}
body.source_params.web_crawler.parse_options.include_images boolean Optional default: false
body.source_params.web_crawler.parse_options.specific_sitemaps array Optional List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. maxItems: 10
body.source_params.web_crawler.parse_options.specific_sitemaps[] string Optional format: "uri"
body.source_params.web_crawler.parse_options.use_browser_rendering boolean Optional default: true
body.source_params.web_crawler.parse_type string Optional How the crawler finds URLs. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to belong to a Verified zone on this account. enum: ["sitemap","discover"]; default: "sitemap"
body.sync_interval — Optional Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Defaults to 86400 (24h).
body.sync_interval number Optional anyOf[1]; enum: [900]
body.sync_interval number Optional anyOf[2]; enum: [1800]
body.sync_interval number Optional anyOf[3]; enum: [3600]
body.sync_interval number Optional anyOf[4]; enum: [7200]
body.sync_interval number Optional anyOf[5]; enum: [14400]
body.sync_interval number Optional anyOf[6]; enum: [21600]
body.sync_interval number Optional anyOf[7]; enum: [43200]
body.sync_interval number Optional anyOf[8]; enum: [86400]
body.token_id string Optional format: "uuid"
body.type string | null Optional Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. enum: ["r2","web-crawler",null]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an AI Search instance. — cloudflare.ai-search-namespace-delete-instance

Deletes an AI Search instance and all its indexed data permanently.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required
path.namespace string Required Namespace name. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "id": "my-ai-search",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an AI Search instance. — cloudflare.ai-search-namespace-fetch-instance

Retrieve the configuration and status of an AI Search instance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required
path.namespace string Required Namespace name. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "id": "my-ai-search",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Move an instance to a different namespace. — cloudflare.ai-search-move-instance

Moves an instance from its current namespace to the specified target namespace. Use 'default' with --destination-namespace to move the instance back to the default namespace. Fails with 400 if the target namespace already has an instance with the same id (ids must be unique within a namespace — the same id can exist in different namespaces).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.namespace string Required Current namespace of the instance.
path.id string Required Instance id.
body object Optional
body.new_namespace string Required Target namespace to move the instance into. pattern: "^[a-z0-9]([a-z0-9-]{0,26}[a-z0-9])?$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "production",
    "id": "my-blog"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an AI Search instance. — cloudflare.ai-search-namespace-update-instance

Updates the configuration of an AI Search instance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required
path.namespace string Required Namespace name. default: "default"
body object Optional
body.ai_gateway_id string | null Optional
body.ai_search_model string | null Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.cache boolean Optional default: true
body.cache_threshold string Optional enum: ["super_strict_match","close_enough","flexible_friend","anything_goes"]; default: "close_enough"
body.cache_ttl — Optional Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). default: 172800
body.cache_ttl number Optional anyOf[1]; enum: [600]
body.cache_ttl number Optional anyOf[2]; enum: [1800]
body.cache_ttl number Optional anyOf[3]; enum: [3600]
body.cache_ttl number Optional anyOf[4]; enum: [7200]
body.cache_ttl number Optional anyOf[5]; enum: [21600]
body.cache_ttl number Optional anyOf[6]; enum: [43200]
body.cache_ttl number Optional anyOf[7]; enum: [86400]
body.cache_ttl number Optional anyOf[8]; enum: [172800]
body.cache_ttl number Optional anyOf[9]; enum: [259200]
body.cache_ttl number Optional anyOf[10]; enum: [518400]
body.chunk boolean Optional default: true
body.chunk_overlap integer Optional default: 10; minimum: 0; maximum: 30
body.chunk_size integer Optional minimum: 64
body.custom_metadata array Optional maxItems: 5
body.custom_metadata[] object Optional
body.custom_metadata[].data_type string Required enum: ["text","number","boolean","datetime"]
body.custom_metadata[].field_name string Required minLength: 1; maxLength: 64
body.embedding_model string | null Optional
body.fusion_method string Optional enum: ["max","rrf"]; default: "rrf"
body.index_method object Optional Controls which storage backends indexing uses. Defaults to vector and keyword indexing for new instances. When set, both vector and keyword are required.
body.index_method.keyword boolean Required Enable keyword (BM25) storage backend.
body.index_method.vector boolean Required Enable vector (embedding) storage backend.
body.indexing_options object | null Optional
body.indexing_options.keyword_tokenizer string Optional Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. enum: ["porter","trigram"]; default: "porter"
body.indexing_options.use_ocr boolean Optional Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. default: false
body.max_num_results integer Optional default: 10; minimum: 1; maximum: 50
body.metadata object Optional
body.metadata.created_from_aisearch_wizard boolean Optional
body.metadata.created_from_emdash_plugin object Optional additionalProperties: true
body.metadata.created_from_emdash_plugin.type string Required enum: ["native","rest"]
body.metadata.created_from_emdash_plugin.version string Required
body.metadata.worker_domain string Optional
body.paused boolean Optional
body.public_endpoint_params object Optional
body.public_endpoint_params.authorized_hosts array Optional
body.public_endpoint_params.authorized_hosts[] string Optional
body.public_endpoint_params.chat_completions_endpoint object Optional
body.public_endpoint_params.chat_completions_endpoint.disabled boolean Optional Disable chat completions endpoint for this public endpoint. default: false
body.public_endpoint_params.custom_domains array | null Optional Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). maxItems: 1
body.public_endpoint_params.custom_domains[] string Optional Custom domain hostname. Must belong to a Verified zone on this account. minLength: 1; maxLength: 253
body.public_endpoint_params.default_domain_enabled boolean Optional When false, the instance is reachable only via a registered custom domain and the default <public_endpoint_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public_endpoint_params is replaced wholesale on update, so resend default_domain_enabled on every update to keep the default host off — omitting it resets to true. default: true
body.public_endpoint_params.enabled boolean Optional default: false
body.public_endpoint_params.mcp object Optional
body.public_endpoint_params.mcp.description string Optional default: "Finds exactly what you're looking for"
body.public_endpoint_params.mcp.disabled boolean Optional Disable MCP endpoint for this public endpoint. default: false
body.public_endpoint_params.rate_limit object Optional
body.public_endpoint_params.rate_limit.period_ms integer Optional minimum: 60000; maximum: 3600000
body.public_endpoint_params.rate_limit.requests integer Optional minimum: 1
body.public_endpoint_params.rate_limit.technique string Optional enum: ["fixed","sliding"]
body.public_endpoint_params.search_endpoint object Optional
body.public_endpoint_params.search_endpoint.disabled boolean Optional Disable search endpoint for this public endpoint. default: false
body.reranking boolean Optional default: false
body.reranking_model string | null Optional
body.retrieval_options object | null Optional
body.retrieval_options.boost_by array Optional Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric/datetime fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. maxItems: 3
body.retrieval_options.boost_by[] object Optional
body.retrieval_options.boost_by[].direction string Optional Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. enum: ["asc","desc","exists","not_exists"]
body.retrieval_options.boost_by[].field string Required Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not_exists); text/boolean fields only support exists/not_exists. minLength: 1; maxLength: 64
body.retrieval_options.keyword_match_mode string Optional Controls which documents become candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term and ranks results according to BM25 relevance. When omitted on an update, the existing stored value stays unchanged; when never set, search falls back to 'and'. enum: ["and","or"]
body.rewrite_model string | null Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.rewrite_query boolean Optional default: false
body.score_threshold number Optional Minimum similarity score a chunk must reach to be returned. Defaults to 0.4. minimum: 0; maximum: 1
body.source string | null Optional
body.source_params object | null Optional
body.source_params.exclude_items array Optional List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced). Most accounts have a limit of 10 rules; contact support to raise it. maxItems: 10
body.source_params.exclude_items[] string Optional maxLength: 500; pattern: "^[*/\\\\]?[\\w\\-/.\\\\?*:=&%]+$"
body.source_params.include_items array Optional List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post). Most accounts have a limit of 10 rules; contact support to raise it. maxItems: 10
body.source_params.include_items[] string Optional maxLength: 500; pattern: "^[*/\\\\]?[\\w\\-/.\\\\?*:=&%]+$"
body.source_params.prefix string Optional
body.source_params.r2_jurisdiction string Optional default: "default"
body.source_params.web_crawler object Optional default: {"parse_type":"sitemap"}
body.source_params.web_crawler.discover_options object Optional Options for parse_type 'discover', where Browser Run discovers URLs through link following and sitemaps. Ignored for 'sitemap'.
body.source_params.web_crawler.discover_options.depth number Optional Maximum link-follow depth from the seed URL. default: 5; minimum: 1; maximum: 100000
body.source_params.web_crawler.discover_options.include_external_links boolean Optional Follow links that point outside the source domain. Must stay false because discover crawls only cover the zone you own. default: false
body.source_params.web_crawler.discover_options.include_subdomains boolean Optional Follow links to subdomains of the source host. default: false
body.source_params.web_crawler.discover_options.limit number Optional Maximum number of pages to crawl (1-100000). default: 100000; minimum: 1; maximum: 100000
body.source_params.web_crawler.discover_options.max_age number Optional Maximum content age in seconds to accept (0–604800). default: 86400; minimum: 0; maximum: 604800
body.source_params.web_crawler.discover_options.source string Optional Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. enum: ["all","sitemaps","links"]; default: "all"
body.source_params.web_crawler.parse_options object Optional
body.source_params.web_crawler.parse_options.content_selector array Optional List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. The crawler stores and indexes only the matched HTML fragment. Omit the field to disable content selection; the API rejects empty arrays. minItems: 1; maxItems: 10
body.source_params.web_crawler.parse_options.content_selector[] object Optional
body.source_params.web_crawler.parse_options.content_selector[].path string Required Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories. minLength: 1; maxLength: 200
body.source_params.web_crawler.parse_options.content_selector[].selector string Required CSS selector to extract content from pages matching the path pattern. Disallowed characters: ;, `, $, {, }, . Must target a single element; if multiple elements match, the crawler ignores the selector and uses the full page. minLength: 1; maxLength: 200
body.source_params.web_crawler.parse_options.include_headers object Optional Up to 5 custom HTTP headers sent with each crawl request. Names must use RFC-7230 token characters, excluding spaces, colons, and control characters. Values must use HTAB and printable ASCII only, excluding CR and LF. additionalProperties: {"maxLength":8192,"pattern":"^[\\t\\x20-\\x7E]*$","type":"string"}
body.source_params.web_crawler.parse_options.include_images boolean Optional default: false
body.source_params.web_crawler.parse_options.specific_sitemaps array Optional List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. maxItems: 10
body.source_params.web_crawler.parse_options.specific_sitemaps[] string Optional format: "uri"
body.source_params.web_crawler.parse_options.use_browser_rendering boolean Optional default: true
body.source_params.web_crawler.parse_type string Optional How the crawler finds URLs. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to belong to a Verified zone on this account. enum: ["sitemap","discover"]; default: "sitemap"
body.summarization boolean Optional default: false
body.summarization_model string | null Optional
body.sync_interval — Optional Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Defaults to 86400 (24h).
body.sync_interval number Optional anyOf[1]; enum: [900]
body.sync_interval number Optional anyOf[2]; enum: [1800]
body.sync_interval number Optional anyOf[3]; enum: [3600]
body.sync_interval number Optional anyOf[4]; enum: [7200]
body.sync_interval number Optional anyOf[5]; enum: [14400]
body.sync_interval number Optional anyOf[6]; enum: [21600]
body.sync_interval number Optional anyOf[7]; enum: [43200]
body.sync_interval number Optional anyOf[8]; enum: [86400]
body.system_prompt_ai_search string | null Optional
body.system_prompt_index_summarization string | null Optional
body.system_prompt_rewrite_query string | null Optional
body.token_id string Optional format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "id": "my-ai-search",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Chat Completions — cloudflare.ai-search-namespace-instance-chat-completion

Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
body object Optional additionalProperties: true
body.ai_search_options object Optional
body.ai_search_options.cache object Optional
body.ai_search_options.cache.cache_threshold string Optional enum: ["super_strict_match","close_enough","flexible_friend","anything_goes"]
body.ai_search_options.cache.enabled boolean Optional
body.ai_search_options.custom_metadata object Optional Metadata added to AI Gateway logs for requests this operation triggers. Accepts up to 2 string, number, or boolean entries. Reserved keys: 'ai-search', 'task', 'origin', and any key beginning with 'cf.'. maxProperties: 2; additionalProperties: {"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}
body.ai_search_options.query_rewrite object Optional
body.ai_search_options.query_rewrite.enabled boolean Optional
body.ai_search_options.query_rewrite.model string Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.ai_search_options.query_rewrite.rewrite_prompt string Optional
body.ai_search_options.reranking object Optional
body.ai_search_options.reranking.enabled boolean Optional
body.ai_search_options.reranking.match_threshold number Optional default: 0.4; minimum: 0; maximum: 1
body.ai_search_options.reranking.model string Optional
body.ai_search_options.retrieval object Optional
body.ai_search_options.retrieval.boost_by array Optional Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. maxItems: 3
body.ai_search_options.retrieval.boost_by[] object Optional
body.ai_search_options.retrieval.boost_by[].direction string Optional Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. enum: ["asc","desc","exists","not_exists"]
body.ai_search_options.retrieval.boost_by[].field string Required Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not_exists); text/boolean fields only support exists/not_exists. minLength: 1; maxLength: 64
body.ai_search_options.retrieval.context_expansion integer Optional default: 0; minimum: 0; maximum: 3
body.ai_search_options.retrieval.filters object Optional additionalProperties: true
body.ai_search_options.retrieval.fusion_method string Optional enum: ["max","rrf"]
body.ai_search_options.retrieval.keyword_match_mode string Optional Controls which documents become candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term and ranks results according to BM25 relevance. When omitted, falls back to the instance-level retrieval_options.keyword_match_mode, then to 'and'. enum: ["and","or"]
body.ai_search_options.retrieval.match_threshold number Optional Minimum similarity score a chunk must reach to be returned. When omitted, falls back to the instance-level score_threshold, then to 0.4. minimum: 0; maximum: 1
body.ai_search_options.retrieval.max_num_results integer Optional Maximum number of results to return. When omitted, falls back to the instance-level max_num_results, then to 10. minimum: 1; maximum: 50
body.ai_search_options.retrieval.retrieval_type string Optional enum: ["vector","keyword","hybrid"]
body.ai_search_options.retrieval.return_on_failure boolean Optional default: true
body.messages array Required minItems: 1
body.messages[] object Optional additionalProperties: true
body.messages[].content — Required
body.messages[].content string Required anyOf[1]
body.messages[].content array Required anyOf[2]; minItems: 1
body.messages[].content[] — Optional anyOf[2]
body.messages[].content[] object Optional anyOf[2]; oneOf[1]
body.messages[].content[].text string Required anyOf[2]; oneOf[1]; minLength: 1
body.messages[].content[].type string Required anyOf[2]; oneOf[1]; enum: ["text"]
body.messages[].content[] object Optional anyOf[2]; oneOf[2]
body.messages[].content[].image_url object Required anyOf[2]; oneOf[2]
body.messages[].content[].image_url.url string Required anyOf[2]; oneOf[2]; minLength: 1; maxLength: 20971520
body.messages[].content[].type string Required anyOf[2]; oneOf[2]; enum: ["image_url"]
body.messages[].content[] object Optional anyOf[2]; oneOf[3]
body.messages[].content[].file object Required anyOf[2]; oneOf[3]
body.messages[].content[].file.file_data string Optional anyOf[2]; oneOf[3]; minLength: 1; maxLength: 13981144
body.messages[].content[].file.file_id string Optional anyOf[2]; oneOf[3]
body.messages[].content[].file.filename string Required anyOf[2]; oneOf[3]; minLength: 1; maxLength: 255
body.messages[].content[].type string Required anyOf[2]; oneOf[3]; enum: ["file"]
body.messages[].content string | null Required anyOf[3]; enum: [null]
body.messages[].role string Required enum: ["system","developer","user","assistant","tool"]
body.model string Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.stream boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Items List. — cloudflare.ai-search-namespace-instance-list-items

Lists indexed items in an AI Search instance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 0; maximum: 50
query.search string Optional maxLength: 256
query.sort_by string Optional Sort order for items. "status" (default) sorts items according to status priority, then last_seen_at. "modified_at" sorts items according to file modification time (most recent first), falling back to created_at. enum: ["status","modified_at"]; default: "status"
query.status string Optional enum: ["queued","running","completed","error","skipped","outdated"]
query.source string Optional Return only items with this source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com". maxLength: 512
query.metadata_filter string Optional JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}. maxLength: 2048
query.item_id string Optional Return only the item with this unique ID. Returns at most one item. maxLength: 64
query.key string Optional Return only items with this exact key (object key / filename). Each key is unique within a source, so combine with source to disambiguate across data sources. maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or Update Item. — cloudflare.ai-search-namespace-instance-create-or-update-item

Creates or updates an indexed item in an AI Search instance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
body object Optional
body.key string Required Item key / filename. Must not exceed 128 characters.
body.next_action string Required enum: ["INDEX"]
body.wait_for_completion boolean Optional Wait for indexing before responding. After processing, vector-indexed instances use any time remaining in a 25s wait budget to confirm Vectorize ingestion. Processing itself continues uninterrupted and can exceed that budget. If confirmation times out, the response returns the current item state and background indexing continues. Defaults to false. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Item. — cloudflare.ai-search-namespace-instance-delete-item

Deletes a file from a managed AI Search instance and removes its indexed data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.item_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "item_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Item. — cloudflare.ai-search-namespace-instance-get-item

Retrieves a specific indexed item from an AI Search instance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.item_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "item_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Sync Item. — cloudflare.ai-search-namespace-instance-sync-item

Synchronizes an item to an AI Search instance index.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.item_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
body object Optional
body.next_action string Required enum: ["INDEX"]
body.wait_for_completion boolean Optional Wait for indexing before responding. After processing, vector-indexed instances use any time remaining in a 25s wait budget to confirm Vectorize ingestion. Processing itself continues uninterrupted and can exceed that budget. If confirmation times out, the response returns the current item state and background indexing continues. Defaults to false. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "item_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Item Chunks. — cloudflare.ai-search-namespace-instance-list-item-chunks

Lists chunks for a specific item in an AI Search instance, including their text content.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.item_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
query object Optional additionalProperties: false
query.limit integer Optional default: 20; minimum: 1; maximum: 100
query.offset integer Optional default: 0; minimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "item_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Item Logs. — cloudflare.ai-search-namespace-instance-logs-item

Lists processing logs for a specific item in an AI Search instance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.item_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
query object Optional additionalProperties: false
query.limit integer Optional default: 50; minimum: 1; maximum: 100
query.cursor string Optional maxLength: 512

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "item_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Jobs — cloudflare.ai-search-namespace-instance-list-jobs

Lists indexing jobs for an AI Search instance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 0; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new job — cloudflare.ai-search-namespace-instance-create-job

Creates a new indexing job for an AI Search instance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
body object Optional
body.description string Optional maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Job Details — cloudflare.ai-search-namespace-instance-get-job

Retrieves details for a specific AI Search indexing job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.job_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "job_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel an indexing job. — cloudflare.ai-search-namespace-instance-change-job-status

Cancels an in-progress indexing job for an AI Search instance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.job_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
body object Optional
body.action string Required enum: ["cancel"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "job_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Job Logs — cloudflare.ai-search-namespace-instance-list-job-logs

Lists log entries for an AI Search indexing job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.job_id string Required
path.account_id string Required
path.namespace string Required Namespace name. default: "default"
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 0; maximum: 500

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "job_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge search cache. — cloudflare.ai-search-namespace-purge-instance-cache

Purges all cached search results for an AI Search instance. A new internal cache key is generated, immediately orphaning all prior cached entries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.namespace string Required Namespace name. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "id": "my-ai-search",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get instance statistics. — cloudflare.ai-search-namespace-stats

Retrieve usage and indexing statistics for an AI Search instance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
path.namespace string Required Namespace name. default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-ai-search",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "namespace": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a namespace — cloudflare.ai-search-delete-namespace

Deletes a namespace permanently. The namespace must not contain any instances (instances whose deletion is still in progress do not count), and the default namespace cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "name": "production"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a namespace — cloudflare.ai-search-fetch-namespace

Retrieve a namespace and its description.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "name": "production"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a namespace — cloudflare.ai-search-update-namespace

Updates the description and/or the public endpoint configuration of an existing namespace. The default namespace's description cannot be modified, but its public endpoint can.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.name string Required
body object Optional
body.description string | null Optional Optional description for the namespace. Max 256 characters. maxLength: 256
body.public_endpoint_params object | null Optional
body.public_endpoint_params.authorized_hosts array Optional
body.public_endpoint_params.authorized_hosts[] string Optional
body.public_endpoint_params.chat_completions_endpoint object Optional
body.public_endpoint_params.chat_completions_endpoint.disabled boolean Optional Disable chat completions endpoint for this public endpoint. default: false
body.public_endpoint_params.custom_domains array | null Optional Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). maxItems: 1
body.public_endpoint_params.custom_domains[] string Optional Custom domain hostname. Must belong to a Verified zone on this account. minLength: 1; maxLength: 253
body.public_endpoint_params.default_domain_enabled boolean Optional When false, the instance is reachable only via a registered custom domain and the default <public_endpoint_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public_endpoint_params is replaced wholesale on update, so resend default_domain_enabled on every update to keep the default host off — omitting it resets to true. default: true
body.public_endpoint_params.enabled boolean Optional default: false
body.public_endpoint_params.instances_allowed array Optional Instance IDs exposed through the namespace public endpoint. Empty means nothing is searchable. Every ID must reference an existing instance in this namespace, and the list must stay within the account's multi-instance search limit. default: []; maxItems: 10
body.public_endpoint_params.instances_allowed[] string Optional AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.public_endpoint_params.mcp object Optional
body.public_endpoint_params.mcp.description string Optional default: "Finds exactly what you're looking for"
body.public_endpoint_params.mcp.disabled boolean Optional Disable MCP endpoint for this public endpoint. default: false
body.public_endpoint_params.rate_limit object Optional
body.public_endpoint_params.rate_limit.period_ms integer Optional minimum: 60000; maximum: 3600000
body.public_endpoint_params.rate_limit.requests integer Optional minimum: 1
body.public_endpoint_params.rate_limit.technique string Optional enum: ["fixed","sliding"]
body.public_endpoint_params.search_endpoint object Optional
body.public_endpoint_params.search_endpoint.disabled boolean Optional Disable search endpoint for this public endpoint. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "name": "production"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Multi-Instance Chat Completions — cloudflare.ai-search-namespace-multi-instance-chat-completion

Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.name string Required Namespace name.
body object Optional additionalProperties: true
body.ai_search_options object Required
body.ai_search_options.cache object Optional
body.ai_search_options.cache.cache_threshold string Optional enum: ["super_strict_match","close_enough","flexible_friend","anything_goes"]
body.ai_search_options.cache.enabled boolean Optional
body.ai_search_options.custom_metadata object Optional Metadata added to AI Gateway logs for requests this operation triggers. Accepts up to 2 string, number, or boolean entries. Reserved keys: 'ai-search', 'task', 'origin', and any key beginning with 'cf.'. maxProperties: 2; additionalProperties: {"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}
body.ai_search_options.instance_ids array Required minItems: 1
body.ai_search_options.instance_ids[] string Optional AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. minLength: 1; maxLength: 64; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
body.ai_search_options.query_rewrite object Optional
body.ai_search_options.query_rewrite.enabled boolean Optional
body.ai_search_options.query_rewrite.model string Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.ai_search_options.query_rewrite.rewrite_prompt string Optional
body.ai_search_options.reranking object Optional
body.ai_search_options.reranking.enabled boolean Optional
body.ai_search_options.reranking.match_threshold number Optional default: 0.4; minimum: 0; maximum: 1
body.ai_search_options.reranking.model string Optional
body.ai_search_options.retrieval object Optional
body.ai_search_options.retrieval.boost_by array Optional Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. maxItems: 3
body.ai_search_options.retrieval.boost_by[] object Optional
body.ai_search_options.retrieval.boost_by[].direction string Optional Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. enum: ["asc","desc","exists","not_exists"]
body.ai_search_options.retrieval.boost_by[].field string Required Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not_exists); text/boolean fields only support exists/not_exists. minLength: 1; maxLength: 64
body.ai_search_options.retrieval.context_expansion integer Optional default: 0; minimum: 0; maximum: 3
body.ai_search_options.retrieval.filters object Optional additionalProperties: true
body.ai_search_options.retrieval.fusion_method string Optional enum: ["max","rrf"]
body.ai_search_options.retrieval.keyword_match_mode string Optional Controls which documents become candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term and ranks results according to BM25 relevance. When omitted, falls back to the instance-level retrieval_options.keyword_match_mode, then to 'and'. enum: ["and","or"]
body.ai_search_options.retrieval.match_threshold number Optional Minimum score a chunk must reach to be returned. When omitted, each instance's chunks are filtered by that instance's score_threshold, capped at the lower of the first instance's score_threshold and 0.4. minimum: 0; maximum: 1
body.ai_search_options.retrieval.max_num_results integer Optional Maximum number of merged results to return. When omitted, defaults to the first instance's max_num_results, then 10. minimum: 1; maximum: 50
body.ai_search_options.retrieval.retrieval_type string Optional enum: ["vector","keyword","hybrid"]
body.ai_search_options.retrieval.return_on_failure boolean Optional default: true
body.messages array Required minItems: 1
body.messages[] object Optional additionalProperties: true
body.messages[].content — Required
body.messages[].content string Required anyOf[1]
body.messages[].content array Required anyOf[2]; minItems: 1
body.messages[].content[] — Optional anyOf[2]
body.messages[].content[] object Optional anyOf[2]; oneOf[1]
body.messages[].content[].text string Required anyOf[2]; oneOf[1]; minLength: 1
body.messages[].content[].type string Required anyOf[2]; oneOf[1]; enum: ["text"]
body.messages[].content[] object Optional anyOf[2]; oneOf[2]
body.messages[].content[].image_url object Required anyOf[2]; oneOf[2]
body.messages[].content[].image_url.url string Required anyOf[2]; oneOf[2]; minLength: 1; maxLength: 20971520
body.messages[].content[].type string Required anyOf[2]; oneOf[2]; enum: ["image_url"]
body.messages[].content[] object Optional anyOf[2]; oneOf[3]
body.messages[].content[].file object Required anyOf[2]; oneOf[3]
body.messages[].content[].file.file_data string Optional anyOf[2]; oneOf[3]; minLength: 1; maxLength: 13981144
body.messages[].content[].file.file_id string Optional anyOf[2]; oneOf[3]
body.messages[].content[].file.filename string Required anyOf[2]; oneOf[3]; minLength: 1; maxLength: 255
body.messages[].content[].type string Required anyOf[2]; oneOf[3]; enum: ["file"]
body.messages[].content string | null Required anyOf[3]; enum: [null]
body.messages[].role string Required enum: ["system","developer","user","assistant","tool"]
body.model string Optional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
body.stream boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "name": "my-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tokens — cloudflare.ai-search-list-tokens

Lists stored AI Search credentials in the account without exposing their secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional Page number (1-indexed). default: 1; minimum: 1; maximum: 100
query.per_page integer Optional Number of results per page. default: 20; minimum: 1; maximum: 100
query.search string Optional Filter tokens whose name contains this string (case-insensitive). maxLength: 256

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a token — cloudflare.ai-search-create-tokens

Create a stored Cloudflare credential for an AI Search instance to access its data source.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.cf_api_id string Required
body.cf_api_key string Required
body.legacy boolean Optional default: true
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a token — cloudflare.ai-search-delete-tokens

Deletes a stored AI Search credential permanently. Credentials in use by an instance cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "id": "62af0db3-c410-40b2-9ee3-0e93f6dd1de0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a token — cloudflare.ai-search-fetch-tokens

Retrieve a stored AI Search credential without exposing its secret.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "id": "62af0db3-c410-40b2-9ee3-0e93f6dd1de0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a token — cloudflare.ai-search-update-tokens

Replace a stored AI Search credential and invalidate cached credentials for instances that use it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.id string Required format: "uuid"
body object Optional
body.cf_api_id string Required
body.cf_api_key string Required
body.legacy boolean Optional default: true
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22",
    "id": "62af0db3-c410-40b2-9ee3-0e93f6dd1de0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Author Search — cloudflare.workers-ai-search-author

Searches Workers AI models by author or organization name.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Finetunes — cloudflare.workers-ai-list-finetunes

Lists all fine-tuning jobs created by the account, including status and metrics.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Finetune — cloudflare.workers-ai-create-finetune

Creates a new fine-tuning job for a Workers AI model using custom training data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.description string Optional
body.model string Required
body.name string Required
body.public boolean Optional default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Public Finetunes — cloudflare.workers-ai-list-public-finetunes

Lists publicly available fine-tuned models that can be used with Workers AI.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.limit number Optional Pagination Limit. default: 20
query.offset number Optional Pagination Offset. default: 0
query.orderBy string Optional Order By Column Name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Finetune — cloudflare.workers-ai-delete-finetune

Delete a finetune. Any in-flight requests referencing the lora will fail after the files are deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.finetune_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "finetune_id": "bc451aef-f723-4b26-a6b2-901afd2e7a8a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Download a Finetune Asset — cloudflare.workers-ai-download-finetune-asset

Returns a pre-signed R2 URL for downloading a finetune asset file.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.finetune_id string Required
path.file_name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "finetune_id": "bc451aef-f723-4b26-a6b2-901afd2e7a8a",
    "file_name": "adapter_model.safetensors"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an AI model's input and output schemas — cloudflare.workers-ai-get-model-schema

Retrieves the input and output JSON Schema definitions for an AI model. Use these definitions to determine the model-specific request fields and response format.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID used for this AI model request.
query object Required additionalProperties: false
query.model string Required AI model identifier, including its namespace and model name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "model": "@cf/meta/llama-3.1-8b-instruct"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Model Search — cloudflare.workers-ai-search-model

Searches Workers AI models by name or description.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.per_page integer Optional default: 100
query.page integer Optional default: 1
query.task string Optional Filter by Task Name. default: ""
query.author string Optional Filter by Author. default: ""
query.source number Optional Filter by Source Id.
query.hide_experimental boolean Optional Filter to hide experimental models. default: false
query.search string Optional Search. default: ""
query.include_deprecated boolean Optional If true, include models for up to three months after their deprecation date. Defaults to false. default: false
query.format string Optional If set, return models in the requested marketplace format instead of the default response. enum: ["openrouter"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run an AI model with request options — cloudflare.workers-ai-post-run-generic

Runs an AI model using a JSON body containing model, input, and optional options fields. Unlike the model-specific URL endpoint, this endpoint takes the model identifier in the body and nests the model's inputs under input.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID used for this AI model request.
body object Optional
body.input object Required JSON object containing the selected model's input fields, such as prompt or messages. Do not include model or options inside this object.
body.model string Required The AI model to execute (e.g., @cf/google/gemma-4-26b-a4b-it, openai/gpt-5.5, anthropic/claude-opus-4.7)
body.options object Optional
body.options.extraHeaders object Optional Additional headers to pass to the AI provider additionalProperties: {"type":"string"}
body.options.gateway object Optional
body.options.gateway.cacheTtl number Optional Cache TTL in seconds
body.options.gateway.id string Optional AI Gateway ID for caching and logging
body.options.gateway.skipCache boolean Optional Skip cache lookup for this request

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Task Search — cloudflare.workers-ai-search-task

Searches Workers AI models by task type (e.g., text-generation, embeddings).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List supported Markdown conversion formats — cloudflare.workers-ai-get-to-markdown-supported

Lists the file extensions and MIME types accepted by Workers AI's Markdown conversion endpoint. Use this list to check whether a file can be converted before uploading it.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID used for this AI model request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Alert Types — cloudflare.notification-alert-types-get-alert-types

Gets a list of all alert types for which an account is eligible.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get delivery mechanism eligibility — cloudflare.notification-mechanism-eligibility-get-delivery-mechanism-eligibility

Get a list of all delivery mechanism types for which an account is eligible.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete PagerDuty Services — cloudflare.notification-destinations-with-pager-duty-delete-pager-duty-services

Deletes all the PagerDuty Services connected to the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List PagerDuty services — cloudflare.notification-destinations-with-pager-duty-list-pager-duty-services

Get a list of all configured PagerDuty services.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create PagerDuty integration token — cloudflare.notification-destinations-with-pager-duty-connect-pager-duty

Creates a new token for integrating with PagerDuty.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Connect PagerDuty — cloudflare.notification-destinations-with-pager-duty-connect-pager-duty-token

Links PagerDuty with the account using the integration token.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.token_id — Required $ref: "#/definitions/aaa_integration-token"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "token_id": "8c71e667571b4f61b94d9e4b12158038"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List webhooks — cloudflare.notification-webhooks-list-webhooks

Gets a list of all configured webhook destinations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a webhook — cloudflare.notification-webhooks-create-a-webhook

Creates a new webhook destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
body object Required
body.name — Required $ref: "#/definitions/aaa_components-schemas-name"
body.secret — Optional $ref: "#/definitions/aaa_secret"
body.url — Required $ref: "#/definitions/aaa_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Slack Webhook",
    "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a webhook — cloudflare.notification-webhooks-delete-a-webhook

Delete a configured webhook destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.webhook_id — Required $ref: "#/definitions/aaa_webhook-id"
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "webhook_id": "b115d5ec15c641ee8b7692c449b5227b",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a webhook — cloudflare.notification-webhooks-get-a-webhook

Get details for a single webhooks destination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.webhook_id — Required $ref: "#/definitions/aaa_webhook-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "webhook_id": "b115d5ec15c641ee8b7692c449b5227b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a webhook — cloudflare.notification-webhooks-update-a-webhook

Update a webhook destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.webhook_id — Required $ref: "#/definitions/aaa_webhook-id"
path.account_id — Required $ref: "#/definitions/aaa_account-id"
body object Required
body.name — Required $ref: "#/definitions/aaa_components-schemas-name"
body.secret — Optional $ref: "#/definitions/aaa_secret"
body.url — Required $ref: "#/definitions/aaa_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "webhook_id": "b115d5ec15c641ee8b7692c449b5227b",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Slack Webhook",
    "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List History — cloudflare.notification-history-list-history

Gets a list of history records for notifications sent to an account. The records are displayed for last x number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
query object Optional additionalProperties: false
query.per_page — Optional $ref: "#/definitions/aaa_per_page"
query.before — Optional $ref: "#/definitions/aaa_before"
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.since string Optional Limit the returned results to history records newer than the specified date. This must be a timestamp that conforms to RFC3339. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Notification policies — cloudflare.notification-policies-list-notification-policies

Get a list of all Notification policies.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Notification policy — cloudflare.notification-policies-delete-a-notification-policy

Delete a Notification policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.policy_id — Required $ref: "#/definitions/aaa_policy-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "0da2b59ef118439d8097bdfb215203c9"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Notification policy — cloudflare.notification-policies-get-a-notification-policy

Get details for a single policy.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.policy_id — Required $ref: "#/definitions/aaa_policy-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "0da2b59ef118439d8097bdfb215203c9"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Notification policy — cloudflare.notification-policies-update-a-notification-policy

Update a Notification policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.policy_id — Required $ref: "#/definitions/aaa_policy-id"
body object Required
body.alert_interval — Optional $ref: "#/definitions/aaa_alert_interval"
body.alert_type — Optional $ref: "#/definitions/aaa_alert_type"
body.description — Optional $ref: "#/definitions/aaa_schemas-description"
body.enabled — Optional $ref: "#/definitions/aaa_enabled"
body.filters — Optional $ref: "#/definitions/aaa_filters"
body.mechanisms — Optional $ref: "#/definitions/aaa_mechanisms"
body.name — Optional $ref: "#/definitions/aaa_schemas-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "0da2b59ef118439d8097bdfb215203c9"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Show email unsubscribe details — cloudflare.notification-policies-show-email-unsubscribe-details

Shows details for unsubscribing an email address from a notification policy.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.policy_id — Required $ref: "#/definitions/aaa_policy-id"
query object Required additionalProperties: false
query.email string Required format: "email"
query.token string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "0da2b59ef118439d8097bdfb215203c9"
  },
  "query": {
    "email": "[email protected]",
    "token": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unsubscribe email from a Notification policy — cloudflare.notification-policies-unsubscribe-email-from-notification-policy

Unsubscribes an email address from a notification policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.policy_id — Required $ref: "#/definitions/aaa_policy-id"
query object Required additionalProperties: false
query.email string Required format: "email"
query.token string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "0da2b59ef118439d8097bdfb215203c9"
  },
  "query": {
    "email": "[email protected]",
    "token": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Test a Notification policy — cloudflare.notification-policies-test-a-notification-policy

Send a test notification for a policy to verify delivery mechanisms are working as expected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.policy_id — Required $ref: "#/definitions/aaa_policy-id"
body object Optional
body.severity integer Optional Severity level for the test alert. Defaults to INFO (1) if omitted. enum: [0,1,2,3,4]
body.source string Optional Source identifier for the test alert.
body.state_correlation_id string Optional Correlation ID for stateful test alerts. Required when state_event is set.
body.state_event integer Optional State event type for stateful test alerts. Use with state_correlation_id. enum: [0,1,2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "0da2b59ef118439d8097bdfb215203c9"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Silences — cloudflare.notification-silences-list-silences

Gets a list of silences for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Silences — cloudflare.notification-silences-create-silences

Creates a new silence for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
body array Required
body[] — Optional $ref: "#/definitions/aaa_silence_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Silences — cloudflare.notification-silences-update-silences

Updates existing silences for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
body array Required
body[] — Optional $ref: "#/definitions/aaa_silence_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Silence — cloudflare.notification-silences-delete-silences

Deletes an existing silence for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.silence_id — Required $ref: "#/definitions/aaa_silence-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "silence_id": "f878e90c23f44126ae3cfc399f646977"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Silence — cloudflare.notification-silences-get-silence

Gets a specific silence for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_account-id"
path.silence_id — Required $ref: "#/definitions/aaa_silence-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "silence_id": "f878e90c23f44126ae3cfc399f646977"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Top integrations by content findings — cloudflare.data-security-content-findings-top-n

Returns the top N integrations ranked by total content findings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier. maxLength: 32; pattern: "^[0-9a-f]{32}$"
body — Required $ref: "#/definitions/art_DataSecurityContentFindingsTopNQuery"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "from": "2024-11-01T00:00:00Z",
    "to": "2024-11-08T00:00:00Z",
    "n": 10,
    "filters": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Data security findings summary — cloudflare.data-security-findings-summary

Returns aggregate current-period and previous-period totals for CASB findings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier. maxLength: 32; pattern: "^[0-9a-f]{32}$"
body — Required $ref: "#/definitions/art_DataSecurityFindingsSummaryQuery"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "from": "2024-11-01T00:00:00Z",
    "to": "2024-11-08T00:00:00Z",
    "filters": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Data security findings timeseries — cloudflare.data-security-findings-timeseries

Returns merged time-bucketed CASB findings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier. maxLength: 32; pattern: "^[0-9a-f]{32}$"
body — Required $ref: "#/definitions/art_DataSecurityFindingsTimeseriesQuery"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "from": "2024-11-01T00:00:00Z",
    "to": "2024-11-08T00:00:00Z",
    "filters": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query analytics summary — cloudflare.art-analytics-query-summary

Returns aggregate summary stats for a dataset. Includes current-period and previous-period totals for trend comparison.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier. maxLength: 32; pattern: "^[0-9a-f]{32}$"
path.dataset string Required Dataset name to query. Examples: access-logins, gateway-http, gateway-dns, gateway-http, shadow-it.
body — Required $ref: "#/definitions/art_QuerySummary"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dataset": "access-logins"
  },
  "body": {
    "from": "2024-11-05T00:00:00Z",
    "to": "2024-11-06T00:00:00Z",
    "groupBy": [
      "country",
      "allowed"
    ],
    "stats": [
      "attemptsTotal"
    ],
    "filters": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query analytics timeseries — cloudflare.art-analytics-query-timeseries

Returns time-bucketed analytics data for a dataset. Includes time slots, each containing the requested stats, group-by dimensions, and resolution-controlled bucket size (e.g. hour, day).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier. maxLength: 32; pattern: "^[0-9a-f]{32}$"
path.dataset string Required Dataset name to query. Examples: access-logins, gateway-http, gateway-dns, gateway-http, shadow-it.
body — Required $ref: "#/definitions/art_QueryTimeseries"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dataset": "shadow_it"
  },
  "body": {
    "from": "2024-11-05T00:00:00Z",
    "to": "2024-11-06T00:00:00Z",
    "groupBy": [
      "country",
      "allowed"
    ],
    "stats": [
      "attemptsTotal"
    ],
    "filters": [],
    "resolution": "hour"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query analytics top-N — cloudflare.art-analytics-query-top-n

Returns the top N results for a dataset by a specified stat. Includes an array of result rows, each containing the requested stats and group-by dimensions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier. maxLength: 32; pattern: "^[0-9a-f]{32}$"
path.dataset string Required Dataset name to query. Examples: access-logins, gateway-http, gateway-dns, gateway-http, shadow-it.
body — Required $ref: "#/definitions/art_QueryTopN"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dataset": "gateway-http"
  },
  "body": {
    "from": "2024-11-05T00:00:00Z",
    "to": "2024-11-06T00:00:00Z",
    "groupBy": [
      "country",
      "allowed"
    ],
    "stats": [
      "attemptsTotal"
    ],
    "filters": [],
    "n": 10,
    "orderBy": "attemptsTotal"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query analytics datasets — cloudflare.sql-api-query-get-account-scoped

Executes a SQL query scoped to the account in the request path. API Gateway preserves the account path, and SQL API requires it to match the signed JWT account, so an accountTag predicate or JSON scope is not required. Explicit account scope must match the path account. Any zone restrictions must belong to that account. Query parameters, time ranges, output formats, authorization, and responses follow the legacy query endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account that authorizes and scopes the request. pattern: "^[a-f0-9]{32}$"
query object Required additionalProperties: false
query.query string Required SQL query to execute. A trailing FORMAT selects JSON, JSONEachRow, TabSeparated, or TSV output on any dataset.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef"
  },
  "query": {
    "query": "SELECT edgeResponseStatus FROM events.httpRequests WHERE datetime > '2026-01-01' LIMIT 10"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query analytics datasets — cloudflare.sql-api-query-post-account-scoped

Executes a SQL query scoped to the account in the request path. API Gateway preserves the account path, and SQL API requires it to match the signed JWT account, so an accountTag predicate or JSON scope is not required. Explicit account scope must match the path account. Any zone restrictions must belong to that account. Query parameters, time ranges, output formats, authorization, and responses follow the legacy query endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account that authorizes and scopes the request. pattern: "^[a-f0-9]{32}$"
body — Required $ref: "#/definitions/analytics-sql_SqlQueryRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef"
  },
  "body": {
    "params": {
      "status": 404
    },
    "query": "SELECT edgeResponseStatus FROM events.httpRequests WHERE edgeResponseStatus = $status LIMIT 10",
    "scope": {
      "accountTag": "0123456789abcdef0123456789abcdef"
    },
    "time_range": {
      "end": "2026-01-02T00:00:00Z",
      "start": "2026-01-01T00:00:00Z"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List available analytics datasets — cloudflare.sql-api-introspection-account-scoped

Returns the dataset catalogue for the account in the request path. API Gateway preserves the account path, and SQL API requires it to match the signed JWT account; account_tag is not required as a query parameter. If supplied, it must match the path account. Dataset and column discovery options are identical to the legacy introspection endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account that authorizes and scopes the request. pattern: "^[a-f0-9]{32}$"
query object Optional additionalProperties: false
query.include_columns boolean Optional Include column metadata for each returned dataset. default: false
query.include_custom_attributes boolean Optional Include a capped set of custom attribute names and types observed during the preceding seven days, as custom_attributes. Requires a nonempty dataset_name. Deprecated in favor of include_attributes. default: false
query.include_attributes boolean Optional Include a capped set of attribute names and types observed during the preceding seven days, as attributes. Requires a nonempty dataset_name. Replaces include_custom_attributes, which is deprecated. default: false
query.include_wae boolean Optional Include Workers Analytics Engine datasets, which are discovered from the account's own data. Set to false to return only datasets described from the static catalogue, which avoids that lookup. default: true
query.include_lex boolean Optional Include Log Explorer datasets, which are listed only where the account has them. Set to false to return only datasets described from the static catalogue, which avoids that lookup. default: true
query.dataset_name string Optional Return only the dataset with this exact name. An empty value is treated as if the parameter had been omitted, and does not filter the catalogue. A name that matches no dataset in this deployment's catalogue is rejected with 422; a dataset that exists but is not describable here is rejected identically, so the two cases cannot be told apart. A Workers Analytics Engine dataset is named in full, as events.analyticsEngine.&lt;dataset_name&gt;; the namespace on its own returns every such dataset the account has. A dataset_name the account does not have is rejected with 422 like any other unknown name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Execute an Analytics Engine SQL query via query parameter — cloudflare.analytics-engine-sql-query-get

Executes a SQL query against Workers Analytics Engine data. Pass the SQL query as a query parameter. The response uses newline-delimited JSON (NDJSON) by default, or a single JSON object when the query includes a FORMAT JSON clause. Use the POST method for longer queries that may exceed URL length limits.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
query object Required additionalProperties: false
query.query string Required Supply a SQL query to run against your Analytics Engine datasets. Use only SELECT statements. The service validates the query against a restricted SQL grammar before execution.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "query": "SELECT blob1, count() FROM my_dataset WHERE timestamp > NOW() - INTERVAL '1' DAY GROUP BY blob1 ORDER BY count() DESC LIMIT 10"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get count of zones with Argo Smart Routing enabled for account — cloudflare.argo-smart-routing-get-count-zones-enabled-for-account

Returns the number of zones that have Argo Smart Routing enabled for the specified account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifier of the account. $ref: "#/definitions/argo-config_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List namespaces — cloudflare.artifacts_namespaces_list

Lists Artifacts namespaces for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Optional additionalProperties: false
query.limit integer Optional default: 100; minimum: 1; maximum: 200
query.cursor string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a namespace — cloudflare.artifacts_namespaces_create

Creates an empty Artifacts namespace for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Required
body.jurisdiction string Optional enum: ["unrestricted","us","eu","fedramp"]; default: "unrestricted"
body.namespace string Required minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "namespace": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a namespace — cloudflare.artifacts_namespaces_delete

Deletes an empty Artifacts namespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a namespace — cloudflare.artifacts_namespaces_get

Returns an Artifacts namespace summary.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories — cloudflare.artifacts_repos_list

Lists repositories in a namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
query object Optional additionalProperties: false
query.limit integer Optional default: 50; minimum: 1; maximum: 200
query.cursor string Optional
query.search string Optional
query.sort string Optional enum: ["created_at","updated_at","last_push_at","name"]; default: "created_at"
query.direction string Optional enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository — cloudflare.artifacts_repos_create

Creates a Git-compatible Artifacts repository in a namespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
body object Required
body.default_branch string Optional Git branch name. Must match /^[a-zA-Z0-9][a-zA-Z0-9._/-]*$/, must not contain '..', and must not end with '/' or '.'. minLength: 1; maxLength: 256; pattern: "^[a-zA-Z0-9][a-zA-Z0-9._/-]*$"
body.description string Optional maxLength: 1024
body.name string Required pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
body.read_only boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository — cloudflare.artifacts_repos_delete

Deletes a repository and schedules cleanup of its backing data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a repository — cloudflare.artifacts_repos_get

Returns repository metadata.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read a Git commit — cloudflare.artifacts_repos_commit_get

Returns decoded metadata for an immutable Git commit object. Commit responses are cacheable forever by hash.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
path.hash string Required 40-character lowercase hexadecimal Git object hash. pattern: "^[0-9a-f]{40}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example",
    "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fork a repository — cloudflare.artifacts_repos_fork

Forks a source repository into a new repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
body object Required
body.default_branch_only boolean Optional
body.description string Optional maxLength: 1024
body.name string Required pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
body.read_only boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Import a repository — cloudflare.artifacts_repos_import

Imports an HTTPS Git repository into an Artifacts repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
body object Required
body.branch string Optional Git branch name. Must match /^[a-zA-Z0-9][a-zA-Z0-9._/-]*$/, must not contain '..', and must not end with '/' or '.'. minLength: 1; maxLength: 256; pattern: "^[a-zA-Z0-9][a-zA-Z0-9._/-]*$"
body.depth integer Optional minimum: 1; maximum: 9007199254740991
body.read_only boolean Optional
body.url string Required format: "uri"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example"
  },
  "body": {
    "url": "https://example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read commit history — cloudflare.artifacts_repos_log_get

Returns commit metadata walking backwards from a ref, branch, tag, or HEAD.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
query object Optional additionalProperties: false
query.ref string Optional Git ref, branch, tag, or commit hash. Defaults to HEAD. minLength: 1
query.limit integer Optional minimum: 1; maximum: 1000
query.offset integer Optional minimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read a raw file with content type — cloudflare.artifacts_repos_raw_get

Returns file bytes resolved by ref and path, with a sniffed content type and browser-safe response headers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
path.ref string Required Git ref, branch, tag, or 40-character commit hash. minLength: 1
path.path string Required File path. May contain slashes. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example",
    "ref": "heads/main",
    "path": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repository tokens — cloudflare.artifacts_repo_tokens_list

Lists tokens for a repository.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
query object Optional additionalProperties: false
query.state string Optional enum: ["active","expired","revoked","all"]; default: "active"
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 30; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read a Git tree — cloudflare.artifacts_repos_tree_get

Returns decoded entries for an immutable Git tree object. A commit hash returns that commit's root tree; a blob or tag hash returns 422. Tree responses are cacheable forever by hash.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
path.name string Required Repository name. pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
path.hash string Required 40-character lowercase hexadecimal Git object hash. pattern: "^[0-9a-f]{40}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example",
    "name": "example",
    "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a repository token — cloudflare.artifacts_tokens_create

Creates a scoped Git token for a repository.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.namespace string Required Artifacts namespace name. minLength: 2; maxLength: 63; pattern: "^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9._])?$"
body object Required
body.repo string Required pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
body.scope string Optional enum: ["read","write"]
body.ttl integer Optional minimum: 60; maximum: 31536000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "namespace": "example"
  },
  "body": {
    "repo": "hello-world"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account audit logs — cloudflare.audit-logs-get-account-audit-logs

Gets a list of audit logs for an account. Can be filtered by who made the change, on which zone, and the timeframe of the change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/aaa_identifier"
query object Optional additionalProperties: false
query.id string Optional Finds a specific log by its ID.
query.export boolean Optional Indicates that this request is an export of logs in CSV format.
query.action.type string Optional Filters by the action type.
query.actor.ip string Optional Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.
query.actor.email string Optional Filters by the email address of the actor that made the change. format: "email"
query.since — Optional
query.since string Optional Limits the returned results to logs newer than the specified date. A full-date that conforms to RFC3339. oneOf[1]; format: "date"
query.since string Optional Limits the returned results to logs newer than the specified date. A date-time that conforms to RFC3339. oneOf[2]; format: "date-time"
query.before — Optional
query.before string Optional Limits the returned results to logs older than the specified date. A full-date that conforms to RFC3339. oneOf[1]; format: "date"
query.before string Optional Limits the returned results to logs older than the specified date. A date-time that conforms to RFC3339. oneOf[2]; format: "date-time"
query.zone.name string Optional Filters by the name of the zone associated to the change.
query.direction string Optional Changes the direction of the chronological sorting. enum: ["desc","asc"]; default: "desc"
query.per_page number Optional Sets the number of results to return per page. default: 100; minimum: 1; maximum: 1000
query.page number Optional Defines which page of results to return. default: 1; minimum: 1
query.hide_user_logs boolean Optional Indicates whether or not to hide user level audit logs. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Files — cloudflare.autorag-config-files

Lists files indexed by an AutoRAG.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required rag id minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 0; maximum: 50
query.search string Optional
query.status string Optional enum: ["completed","queued","running","error"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-rag",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Jobs — cloudflare.autorag-config-list-jobs

Lists jobs for an AutoRAG.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required rag id minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 0; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-rag",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Job Details — cloudflare.autorag-config-get-job

Returns details for an AutoRAG job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required rag id minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.job_id string Required
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-rag",
    "job_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Job Logs — cloudflare.autorag-config-list-job-logs

Lists logs for an AutoRAG job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required rag id minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.job_id string Required
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 0; maximum: 500

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-rag",
    "job_id": "example",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Sync — cloudflare.autorag-config-sync

Starts synchronization for an AutoRAG.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required rag id minLength: 1; maxLength: 32; pattern: "^[a-z0-9_]+(?:-[a-z0-9_]+)*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "my-rag",
    "account_id": "c3dc5f0b34a14ff8e1b3ec04895e1b22"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Basin Catalogs — cloudflare.basin-list-catalogs

Returns a list of R2 buckets that have been enabled as Apache Iceberg catalogs for the specified account. Each catalog represents an R2 bucket configured to store Iceberg metadata and data files.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Basin Catalog details — cloudflare.basin-get-catalog-details

Retrieve detailed information about a specific Basin Catalog by bucket name. Returns catalog status, maintenance configuration, and credential status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Store catalog credentials — cloudflare.basin-store-credentials

Store authentication credentials for a catalog. These credentials are used to authenticate with R2 storage when performing catalog operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"
body — Required $ref: "#/definitions/r2-data-catalog_catalog-credential-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  },
  "body": {
    "token": "your-cloudflare-api-token-here"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Basin Catalog credential status — cloudflare.basin-get-credential-status

Check whether the configured catalog credentials are valid, invalid, or absent by probing authentication against the catalog.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Basin Catalog metadata — cloudflare.basin-delete-catalog

Removes the catalog from the control plane without deleting R2 bucket objects. Set force=true to remove catalog namespaces, tables, views, and maintenance metadata. Force deletion is limited to a configured catalog object count.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required $ref: "#/definitions/r2-data-catalog_bucket-name"
query object Optional additionalProperties: false
query.force boolean Optional Remove child metadata before deleting the catalog. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable Basin Catalog — cloudflare.basin-disable-catalog

Disable an R2 bucket as a catalog. This operation deactivates the catalog but preserves existing metadata and data files. The catalog can be re-enabled later.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name to disable as catalog. $ref: "#/definitions/r2-data-catalog_bucket-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable R2 bucket as a catalog — cloudflare.basin-enable-catalog

Enable an R2 bucket as an Apache Iceberg catalog. This operation creates the necessary catalog infrastructure and activates the bucket for storing Iceberg metadata and data files.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name to enable as catalog. $ref: "#/definitions/r2-data-catalog_bucket-name"
body — Optional $ref: "#/definitions/r2-data-catalog_catalog-activation-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get catalog maintenance configuration — cloudflare.basin-get-maintenance-config

Retrieve the maintenance configuration for a specific catalog, including compaction settings and credential status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update catalog maintenance configuration — cloudflare.basin-update-maintenance-config

Update the maintenance configuration for a catalog. This allows you to enable or disable compaction and adjust target file sizes for optimization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"
body — Required $ref: "#/definitions/r2-data-catalog_catalog-maintenance-update-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List namespaces in catalog — cloudflare.basin-list-namespaces

Returns a list of namespaces in the specified Basin Catalog. Supports hierarchical filtering and pagination for efficient traversal of large namespace hierarchies.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"
query object Optional additionalProperties: false
query.page_token string Optional Opaque pagination token from a previous response. Use this to fetch the next page of results.
query.page_size integer Optional Maximum number of namespaces to return per page. Defaults to 100, maximum 1000. default: 100; minimum: 1; maximum: 1000
query.parent string Optional Parent namespace to filter by. Only returns direct children of this namespace. For nested namespaces, use %1F as separator (e.g., "bronze%1Fanalytics"). Omit this parameter to list top-level namespaces.
query.return_uuids boolean Optional Whether to include namespace UUIDs in the response. Set to true to receive the namespace_uuids array. default: false
query.return_details boolean Optional Whether to include additional metadata (timestamps). When true, response includes created_at and updated_at arrays. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tables in namespace — cloudflare.basin-list-tables

Returns a list of tables in the specified namespace within a Basin Catalog. Supports pagination for efficient traversal of large table collections.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"
path.namespace string Required The namespace identifier. For nested namespaces, use %1F as separator (e.g., "bronze%1Fanalytics").
query object Optional additionalProperties: false
query.page_token string Optional Opaque pagination token from a previous response. Use this to fetch the next page of results.
query.page_size integer Optional Maximum number of tables to return per page. Defaults to 100, maximum 1000. default: 100; minimum: 1; maximum: 1000
query.return_uuids boolean Optional Whether to include table UUIDs in the response. Set to true to receive the table_uuids array. default: false
query.return_details boolean Optional Whether to include additional metadata (timestamps, locations). When true, response includes created_at, updated_at, metadata_locations, and locations arrays. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket",
    "namespace": "bronze"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get table details — cloudflare.basin-get-table

Returns full Apache Iceberg metadata for a single table: schema, partition specs, sort orders, properties, and recent snapshot history. Designed for catalog introspection UIs that need per-table details without holding R2 credentials.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"
path.namespace string Required The namespace identifier. For nested namespaces, use %1F as separator (e.g., "bronze%1Fanalytics").
path.table_name string Required The table name within the given namespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket",
    "namespace": "bronze",
    "table_name": "events"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get table maintenance configuration — cloudflare.basin-get-table-maintenance-config

Retrieve the maintenance configuration for a specific table, including compaction settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"
path.namespace string Required The namespace identifier (use %1F as separator for nested namespaces).
path.table_name string Required The table name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket",
    "namespace": "example",
    "table_name": "my_table"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update table maintenance configuration — cloudflare.basin-update-table-maintenance-config

Update the maintenance configuration for a specific table. This allows you to enable or disable compaction and adjust target file sizes for optimization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the account. $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required Specifies the R2 bucket name. $ref: "#/definitions/r2-data-catalog_bucket-name"
path.namespace string Required The namespace identifier (use %1F as separator for nested namespaces).
path.table_name string Required The table name.
body — Required $ref: "#/definitions/r2-data-catalog_table-maintenance-update-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket",
    "namespace": "example",
    "table_name": "my_table"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Queue table maintenance — cloudflare.basin-queue-table-maintenance

Queue maintenance for normal polling. This request does not start a run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required $ref: "#/definitions/r2-data-catalog_bucket-name"
path.namespace string Required
path.table_name string Required
path.configuration_type string Required enum: ["compaction","snapshot_expiration"]
body — Required $ref: "#/definitions/r2-data-catalog_queue-maintenance-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket",
    "namespace": "example",
    "table_name": "example",
    "configuration_type": "compaction"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List table maintenance runs — cloudflare.basin-list-table-maintenance-runs

Retrieves recent table maintenance runs for the current table.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2-data-catalog_account-id"
path.bucket_name — Required $ref: "#/definitions/r2-data-catalog_bucket-name"
path.namespace string Required
path.table_name string Required
query object Optional additionalProperties: false
query.page_size integer Optional minimum: 1; maximum: 100
query.page_token string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123456789abcdef0123456789abcdef",
    "bucket_name": "my-data-bucket",
    "namespace": "example",
    "table_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account Billable Usage (Version 1, Alpha) — cloudflare.billable-usage-get-v1-account-usage

Returns billable usage data for the account. When no query parameters are provided, returns usage for the current billing period.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account. $ref: "#/definitions/billable-usage-api_identifier"
query object Optional additionalProperties: false
query.from string Optional Start date for the usage query (ISO 8601). The provided time range must include the subscription billing cycle anchor day, otherwise no usage data is returned. Use the info endpoint to retrieve the subscription anchor day. format: "date"
query.to string Optional End date for the usage query (ISO 8601). format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account Billable Usage Info (Version 1, Alpha) — cloudflare.billable-usage-get-v1-account-usage-info

Returns high-level usage information for the account, including coverage, and subscription metadata.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account. $ref: "#/definitions/billable-usage-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account Usage (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-get-account-usage

Returns cost and usage data for a single Cloudflare account, aligned with the FinOps FOCUS v1.3 Cost and Usage dataset specification.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account. $ref: "#/definitions/billable-usage-api_identifier"
query object Optional additionalProperties: false
query.from string Optional Start date for the usage query (ISO 8601). Required if to is set. When omitted along with to, defaults to the start of the current month. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. format: "date"
query.to string Optional End date for the usage query (ISO 8601). Required if from is set. When omitted along with from, defaults to today. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query Account Usage (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-query-account-usage

Returns cost and usage data for a single Cloudflare account, aligned with the FinOps FOCUS v1.3 Cost and Usage dataset specification.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account. $ref: "#/definitions/billable-usage-api_identifier"
body — Optional $ref: "#/definitions/billable-usage-api_v2_usage_query"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Account Billable Metrics (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-get-account-billable-metrics

Lists billable metrics available to the account through contracts and subscriptions that overlap the requested period. Results are deduplicated and ordered. If no qualifying contract exists, the result is an empty array.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account. $ref: "#/definitions/billable-usage-api_identifier"
query object Optional additionalProperties: false
query.from string Optional Start date for the usage query (ISO 8601). Required if to is set. When omitted along with to, defaults to the start of the current month. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. format: "date"
query.to string Optional End date for the usage query (ISO 8601). Required if from is set. When omitted along with from, defaults to today. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account Bad Debt — cloudflare.account-billing-get-bad-debt

Gets bad debt information for an account, including outstanding invoices and total debt amount.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account Credits — cloudflare.account-billing-get-credits

Gets the credit balance and eligibility for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account Billing History — cloudflare.account-billing-history-get-billing-history

Gets the billing history for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of items per page. default: 20; minimum: 1
query.status string Optional Filter billing history by status.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Billing Profile — cloudflare.account-billing-profile-delete-billing-profile

Deletes the billing profile for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Billing Profile — cloudflare.account-billing-profile-get-billing-profile

Gets the current billing profile for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Billing Email — cloudflare.account-billing-profile-update-billing-email

Updates the billing email addresses and preferred locale for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body object Required
body.billing_email string Optional
body.preferred_locale string Optional
body.secondary_billing_email string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Billing Profile — cloudflare.account-billing-profile-create-billing-profile

Creates a billing profile for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_billing_profile_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Billing Profile — cloudflare.account-billing-profile-update-billing-profile

Updates the billing profile for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_billing_profile_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Payment Intent for Billing Profile — cloudflare.account-billing-create-payment-intent

Creates a Stripe payment intent for adding or updating a payment method on the account's billing profile. Returns a client secret for frontend payment method collection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Spend Policies — cloudflare.spend-policies-list

Returns every spend policy on the account that has not been deleted, including disabled ones. Results are sorted by name, then id. There is no pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account (account tag). $ref: "#/definitions/billing-spend-policies_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Spend Policy — cloudflare.spend-policies-create

Creates a spend policy. Each account can have only one enabled usage_block policy per product. A second one returns 409. There is no limit on notification policies.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account (account tag). $ref: "#/definitions/billing-spend-policies_identifier"
body — Required $ref: "#/definitions/billing-spend-policies_policy_input"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Workers cap",
    "product_id": "workers",
    "enabled": true,
    "threshold_cents": 100,
    "action": "notification"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Spend Policy Activity — cloudflare.spend-policies-activity

Returns configuration history from immutable policy revisions for the account, including deleted policies. Entries contain before/after values and verified actor attribution. Pages use descending revision IDs, not event or commit order; refresh the first page for new entries. This cursor is not an incremental consumer checkpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account (account tag). $ref: "#/definitions/billing-spend-policies_identifier"
query object Optional additionalProperties: false
query.limit integer Optional Maximum number of audit entries to return. Defaults to 50. Values above 100 are capped at 100 rather than rejected. default: 50; minimum: 1
query.cursor string Optional Opaque token from the preceding response's result_info.cursor. Pass it unchanged to retrieve older entries. maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Spend Policy — cloudflare.spend-policies-delete

Soft-deletes the spend policy. The policy is disabled and no longer appears in list, get or audit responses. The If-Match header must equal the policy's current version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account (account tag). $ref: "#/definitions/billing-spend-policies_identifier"
path.policy_id — Required Identifies the spend policy. $ref: "#/definitions/billing-spend-policies_policy_id"
headers object Required additionalProperties: false
headers.If-Match string Required The policy version the change is based on, as returned in ETag. Quoted ("3") and bare (3) values are both accepted. Weak ETags (W/"3") and * are not. pattern: "^\"?[1-9][0-9]*\"?$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d"
  },
  "headers": {
    "If-Match": "\"3\""
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Spend Policy — cloudflare.spend-policies-get

Returns one spend policy. The ETag response header holds the current version; send it as If-Match on a later update or delete.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account (account tag). $ref: "#/definitions/billing-spend-policies_identifier"
path.policy_id — Required Identifies the spend policy. $ref: "#/definitions/billing-spend-policies_policy_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Spend Policy — cloudflare.spend-policies-update

Replaces the whole spend policy. Every field is required, as on create; there are no partial updates and PATCH is not supported. The If-Match header must equal the policy's current version. On success, version goes up by one and the new value is returned in ETag.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account (account tag). $ref: "#/definitions/billing-spend-policies_identifier"
path.policy_id — Required Identifies the spend policy. $ref: "#/definitions/billing-spend-policies_policy_id"
headers object Required additionalProperties: false
headers.If-Match string Required The policy version the change is based on, as returned in ETag. Quoted ("3") and bare (3) values are both accepted. Weak ETags (W/"3") and * are not. pattern: "^\"?[1-9][0-9]*\"?$"
body — Required $ref: "#/definitions/billing-spend-policies_policy_input"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d"
  },
  "headers": {
    "If-Match": "\"3\""
  },
  "body": {
    "name": "Workers cap",
    "product_id": "workers",
    "enabled": true,
    "threshold_cents": 100,
    "action": "notification"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Spend Policy Audit Entries — cloudflare.spend-policies-list-audit

Returns the policy's evaluation history, newest first. At most one entry is recorded per trigger (approaching_limit or limit_reached), policy version and billing period, so a policy update can record a new entry without any change in balance. Disabled policies still return their history; deleted policies return 404. There is no pagination: use limit to set how many entries come back.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifies the Cloudflare account (account tag). $ref: "#/definitions/billing-spend-policies_identifier"
path.policy_id — Required Identifies the spend policy. $ref: "#/definitions/billing-spend-policies_policy_id"
query object Optional additionalProperties: false
query.limit integer Optional Maximum number of audit entries to return. Defaults to 50. Values above 100 are capped at 100 rather than rejected. default: 50; minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Unpaid Invoices — cloudflare.account-billing-get-unpaid-invoices

Gets unpaid invoice information for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account billing usage — cloudflare.usage-analytics-get-account-billing-usage

Retrieve billing usage analytics for an account. Returns time-series data for all billable product metrics including Stream, Media (Images), Rate Limiting, Load Balancing, Argo, Workers, Workers KV, Image Resizing, and Spectrum.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Standard Cloudflare hex account identifier. The API gateway translates this to an internal numeric ID before forwarding to the backend service. $ref: "#/definitions/usage-analytics_identifier"
query object Optional additionalProperties: false
query.metrics string Optional Comma-separated list of metrics to include in the response. Available metrics depend on the endpoint. Billing usage supports: streamMinutesViewed, rateLimitingRequestsAllowed, loadBalancingQueries, argoAcceleratedBytes, workersRequests, workersKVReads, imageResizingRequests, spectrumBytesTransferred, mediaUniqueTransformations. Stream/media usage supports: streamMinutesViewed.
query.since string Optional Start of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to 6 hours before the current time. format: "date-time"
query.until string Optional End of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to the current time. format: "date-time"
query.time_delta string Optional Time unit to aggregate usage observations into. Data retention is approximately 18 months. The effective number of data points returned depends on the time range and granularity selected. For example, requesting hourly granularity over 18 months could produce up to ~13,000 data points; use the limit parameter to cap results and be aware that responses may be truncated. enum: ["hour","day","week","month","quarter","year"]; default: "hour"
query.limit integer Optional Maximum number of data points to return. The actual number of results depends on the interaction between the time range (since/until) and time_delta granularity. Results are truncated to this limit without error if the time range produces more data points than the limit allows. default: 100; minimum: 1; maximum: 10000
query.filters string Optional Filter expressions to apply to the query. Format: field==value. Multiple filters can be combined.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get daily report — cloudflare.botnet-threat-feed-get-day-report

Gets all the data the botnet tracking database has for a given ASN registered to user account for given date. If no date is given, it will return results for the previous day.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/botnet-feed-api_identifier"
path.asn_id — Required $ref: "#/definitions/botnet-feed-api_asn"
query object Optional additionalProperties: false
query.date — Optional $ref: "#/definitions/botnet-feed-api_timestamp"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "asn_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get full report — cloudflare.botnet-threat-feed-get-full-report

Gets all the data the botnet threat feed tracking database has for a given ASN registered to user account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/botnet-feed-api_identifier"
path.asn_id — Required $ref: "#/definitions/botnet-feed-api_asn"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "asn_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get list of ASNs — cloudflare.botnet-threat-feed-list-asn

Gets a list of all ASNs registered for a user for the DDoS Botnet Feed API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/botnet-feed-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an ASN — cloudflare.botnet-threat-feed-delete-asn

Delete an ASN from botnet threat feed for a given user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/botnet-feed-api_identifier"
path.asn_id — Required $ref: "#/definitions/botnet-feed-api_asn"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "asn_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read matches for logo queries by ID — cloudflare.getaccountsaccountidbrandprotectionlogomatches

Return matches for logo queries based on ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.logo_id array Optional
query.logo_id[] string Optional
query.offset string Optional
query.limit string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Download matches for logo queries by ID — cloudflare.getaccountsaccountidbrandprotectionlogomatchesdownload

Return matches as CSV for logo queries based on ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.logo_id array Optional
query.logo_id[] string Optional
query.offset string Optional
query.limit string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete saved logo queries by ID — cloudflare.deleteaccountsaccountidbrandprotectionlogoslogoid

Return a success message after deleting saved logo queries by ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.logo_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "logo_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read matches for string queries by ID — cloudflare.getaccountsaccountidbrandprotectionmatches

Return matches for string queries based on ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.id string Optional
query.offset integer Optional
query.limit integer Optional
query.include_domain_id boolean Optional
query.include_dismissed boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Download matches for string queries by ID — cloudflare.getaccountsaccountidbrandprotectionmatchesdownload

Return matches as CSV for string queries based on ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.id string Optional
query.offset integer Optional
query.limit integer Optional
query.include_domain_id boolean Optional
query.include_dismissed boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete saved string queries by ID — cloudflare.deleteaccountsaccountidbrandprotectionqueries

Return a success message after deleting saved string queries by ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.id string Optional
query.tag string Optional
query.scan boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new saved string queries — cloudflare.postaccountsaccountidbrandprotectionqueries

Return a success message after creating new saved string queries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.id string Optional
query.tag string Optional
query.scan boolean Optional
body — Required $ref: "#/definitions/brand-protection-api_Query"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new saved string queries in bulk — cloudflare.postaccountsaccountidbrandprotectionqueriesbulk

Return a success message after creating new saved string queries in bulk.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body — Required $ref: "#/definitions/brand-protection-api_QueryBulk"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new URL submissions — cloudflare.postaccountsaccountidbrandprotectionsubmit

Return new URL submissions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read submitted URLs by ID — cloudflare.getaccountsaccountidbrandprotectionurlinfo

Return submitted URLs based on ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete browser extension configuration — cloudflare.accounts-browser-extension-config-delete

Deletes the browser extension configuration for an account. The shard mapping is preserved and not deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get browser extension configuration — cloudflare.accounts-browser-extension-config-get

Returns the browser extension configuration for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create browser extension configuration — cloudflare.accounts-browser-extension-config-post

Creates the browser extension configuration for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
body — Required $ref: "#/definitions/brex_CreateConfigRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "config": {
      "team_name": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update browser extension configuration — cloudflare.accounts-browser-extension-config-put

Replaces the browser extension configuration for an account. The configuration must already exist. The shard mapping is immutable.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
body — Required $ref: "#/definitions/brex_UpdateConfigRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "config": {
      "team_name": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List browser extension inventories — cloudflare.accounts-browser-extension-inventories-list

Returns the installed extension inventory for each registered browser extension device in the account. Each device reports its inventory periodically; this endpoint returns the latest known snapshot per device.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
query object Optional additionalProperties: false
query.cursor string Optional Opaque cursor from a previous response to fetch the next page.
query.per_page integer Optional Number of results per page (default 50, max 200). default: 50; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a single browser extension inventory — cloudflare.accounts-browser-extension-inventories-get

Returns the installed extension inventory for a single registered browser extension device.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
path.registration_id string Required Browser extension registration ID. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "registration_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query browser extension event timeseries — cloudflare.accounts-browser-extension-config-extension-events-timeseries

Returns browser extension event counts grouped by time bucket and the requested groupBy fields. Accepts the same filters as event log search. When resolution is omitted, ranges shorter than 10 days use 1 hours buckets and ranges of 10 days or more use 1 days. Empty buckets are omitted. Results over 10000 slots return 400.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
body — Required $ref: "#/definitions/brex_ExtensionEventsTimeseriesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "from": "2026-01-01T00:00:00Z",
    "to": "2026-01-01T00:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get accessibility tree page — cloudflare.brapi-post_accessibilitytree

Returns the page's accessibility tree. Use interestingOnly to only return semantically meaningful nodes; use root to scope the tree to a CSS-selector-anchored subtree. Control page loading with gotoOptions and waitFor options.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.emulateMediaType string Optional
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.interestingOnly boolean Optional
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.root string Optional
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get HTML content. — cloudflare.brapi-post_content

Fetches rendered HTML content from provided URL or HTML. Check available options like gotoOptions and waitFor to control page load behaviour.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.emulateMediaType string Optional
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Crawl websites. — cloudflare.brapi-post_crawl

Starts a crawl job for the provided URL and its children. Check available options like gotoOptions and waitFor to control page load behaviour.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
body — Required
body object Required anyOf[1]; additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. anyOf[1]; maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content. anyOf[1]
body.addScriptTag[] object Optional anyOf[1]; additionalProperties: false
body.addScriptTag[].content string Optional anyOf[1]
body.addScriptTag[].id string Optional anyOf[1]
body.addScriptTag[].type string Optional anyOf[1]
body.addScriptTag[].url string Optional anyOf[1]; format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a ` anyOf[1]
body.addStyleTag[] object Optional anyOf[1]
body.addStyleTag[].content string Optional anyOf[1]
body.addStyleTag[].url string Optional anyOf[1]; format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first. anyOf[1]
body.allowRequestPattern[] string Optional anyOf[1]
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first. anyOf[1]
body.allowResourceTypes[] — Optional anyOf[1]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[1]; anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication. anyOf[1]
body.authenticate.password string Required anyOf[1]; minLength: 1
body.authenticate.username string Required anyOf[1]; minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout. anyOf[1]
body.browser string Optional Rendering backend for this crawl. Set to kitesurf to render pages with Kitesurf (beta). Only valid when render is true. anyOf[1]; enum: ["kitesurf"]
body.contentUse — Optional Intended content use level to respect the use Content-Signal directive in robots.txt. Levels (least to most permissive): 'reference', 'full'. A URL is disallowed when the publisher's declared use level is lower than this intent. Learn more: https://contentsignals.org/. Default: 'full'. anyOf[1]; default: "full"
body.contentUse string Optional anyOf[1]; anyOf[1]; enum: ["reference"]
body.contentUse string Optional anyOf[1]; anyOf[2]; enum: ["full"]
body.cookies array Optional Check options. anyOf[1]
body.cookies[] object Optional anyOf[1]
body.cookies[].domain string Optional anyOf[1]
body.cookies[].expires number Optional anyOf[1]
body.cookies[].httpOnly boolean Optional anyOf[1]
body.cookies[].name string Required Cookie name. anyOf[1]
body.cookies[].partitionKey string Optional anyOf[1]
body.cookies[].path string Optional anyOf[1]
body.cookies[].priority — Optional anyOf[1]
body.cookies[].priority string Optional anyOf[1]; anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[1]; anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[1]; anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional anyOf[1]
body.cookies[].sameSite — Optional anyOf[1]
body.cookies[].sameSite string Optional anyOf[1]; anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[1]; anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[1]; anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional anyOf[1]
body.cookies[].sourcePort number Optional anyOf[1]
body.cookies[].sourceScheme — Optional anyOf[1]
body.cookies[].sourceScheme string Optional anyOf[1]; anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[1]; anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[1]; anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional anyOf[1]
body.cookies[].value string Required anyOf[1]
body.crawlPurposes array Optional List of crawl purposes to respect Content-Signal directives in robots.txt. Allowed values: 'search', 'ai-input', 'ai-train'. Learn more: https://contentsignals.org/. Default: ['search', 'ai-input', 'ai-train']. anyOf[1]; default: ["search","ai-input","ai-train"]; minItems: 1; maxItems: 3
body.crawlPurposes[] — Optional anyOf[1]
body.crawlPurposes[] string Optional anyOf[1]; anyOf[1]; enum: ["search"]
body.crawlPurposes[] string Optional anyOf[1]; anyOf[2]; enum: ["ai-input"]
body.crawlPurposes[] string Optional anyOf[1]; anyOf[3]; enum: ["ai-train"]
body.depth number Optional Maximum number of levels deep the crawler will traverse from the starting URL. anyOf[1]; default: 100000; minimum: 1; maximum: 100000
body.emulateMediaType string Optional anyOf[1]
body.formats array Optional Formats to return. Default is html. anyOf[1]; default: ["html"]
body.formats[] — Optional anyOf[1]
body.formats[] string Optional anyOf[1]; anyOf[1]; enum: ["html"]
body.formats[] string Optional anyOf[1]; anyOf[2]; enum: ["markdown"]
body.formats[] string Optional anyOf[1]; anyOf[3]; enum: ["json"]
body.gotoOptions object Optional Check options. anyOf[1]; default: {}
body.gotoOptions.referer string Optional anyOf[1]
body.gotoOptions.referrerPolicy string Optional anyOf[1]
body.gotoOptions.timeout number Optional anyOf[1]; default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional anyOf[1]; default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[1]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[1]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[1]; anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[1]; anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[1]; anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[1]; anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[1]; anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[1]; anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[1]; anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.jsonOptions object Optional Options for JSON extraction. anyOf[1]; additionalProperties: false
body.jsonOptions.custom_ai array Optional Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback. anyOf[1]
body.jsonOptions.custom_ai[] object Optional anyOf[1]
body.jsonOptions.custom_ai[].authorization string Optional Authorization token for the AI model: Bearer &lt;token&gt;. Not needed for workers-ai models. anyOf[1]
body.jsonOptions.custom_ai[].model string Required AI model to use for the request. Must be formed as &lt;provider&gt;/&lt;model_name&gt;, e.g. workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast. anyOf[1]
body.jsonOptions.prompt string Optional anyOf[1]
body.jsonOptions.response_format object Optional anyOf[1]
body.jsonOptions.response_format.json_schema object | null Optional Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/ anyOf[1]; additionalProperties: true
body.jsonOptions.response_format.type string Required anyOf[1]
body.limit number Optional Maximum number of URLs to crawl. anyOf[1]; default: 10; minimum: 1; maximum: 100000
body.maxAge number Optional Maximum age of a resource that can be returned from cache in seconds. Default is 1 day. anyOf[1]; default: 86400; minimum: 0; maximum: 604800
body.modifiedSince integer Optional Unix timestamp (seconds since epoch) indicating to only crawl pages that were modified since this time. For sitemap URLs with a lastmod field, this is compared directly. For other URLs, the crawler will use If-Modified-Since header when fetching. URLs without modification information (no lastmod in sitemap and no Last-Modified header support) will be crawled. Note: This works in conjunction with maxAge - both filters must pass for a cached resource to be used. Must be within the last year and not in the future. anyOf[1]; exclusiveMinimum: 0
body.options object Optional Additional options for the crawler. anyOf[1]; default: {"includeExternalLinks":false,"includeSubdomains":false}
body.options.excludePatterns array Optional Exclude links matching the provided wildcard patterns in the crawl job. Example: 'https://example.com/privacy/**'. anyOf[1]; maxItems: 100
body.options.excludePatterns[] string Optional anyOf[1]; minLength: 1; maxLength: 500
body.options.includeExternalLinks boolean Optional Include external links in the crawl job. If set to true, includeSubdomains is ignored. anyOf[1]; default: false
body.options.includePatterns array Optional Include only links matching the provided wildcard patterns in the crawl job. Include patterns are evaluated before exclude patterns. URLs that match any of the specified include patterns will be included in the crawl job. Example: 'https://example.com/blog/**'. anyOf[1]; maxItems: 100
body.options.includePatterns[] string Optional anyOf[1]; minLength: 1; maxLength: 500
body.options.includeSubdomains boolean Optional Include links to subdomains in the crawl job. This option is ignored if includeExternalLinks is true. anyOf[1]; default: false
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'. anyOf[1]
body.rejectRequestPattern[] string Optional anyOf[1]
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'. anyOf[1]
body.rejectResourceTypes[] — Optional anyOf[1]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[1]; anyOf[18]; enum: ["other"]
body.render boolean Optional Whether to render the page or fetch static content. True by default. anyOf[1]; enum: [true]; default: true
body.setExtraHTTPHeaders object Optional anyOf[1]; additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional anyOf[1]
body.source — Optional Source of links to crawl. 'sitemaps' - only crawl URLs from sitemaps, 'links' - only crawl URLs scraped from pages, 'all' - crawl both sitemap and scraped links (default). anyOf[1]; default: "all"
body.source string Optional anyOf[1]; anyOf[1]; enum: ["sitemaps"]
body.source string Optional anyOf[1]; anyOf[2]; enum: ["links"]
body.source string Optional anyOf[1]; anyOf[3]; enum: ["all"]
body.url string Required URL to navigate to, eg. https://example.com. anyOf[1]; format: "uri"
body.viewport object Optional Check options. anyOf[1]; default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional anyOf[1]
body.viewport.hasTouch boolean Optional anyOf[1]
body.viewport.height number Required anyOf[1]
body.viewport.isLandscape boolean Optional anyOf[1]
body.viewport.isMobile boolean Optional anyOf[1]
body.viewport.width number Required anyOf[1]
body.waitForSelector object Optional Wait for the selector to appear in page. Check options. anyOf[1]
body.waitForSelector.hidden boolean Optional anyOf[1]; enum: [true]
body.waitForSelector.selector string Required anyOf[1]
body.waitForSelector.timeout number Optional anyOf[1]; maximum: 120000
body.waitForSelector.visible boolean Optional anyOf[1]; enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. anyOf[1]; maximum: 120000
body object Required anyOf[2]; additionalProperties: false
body.contentUse — Optional Intended content use level to respect the use Content-Signal directive in robots.txt. Levels (least to most permissive): 'reference', 'full'. A URL is disallowed when the publisher's declared use level is lower than this intent. Learn more: https://contentsignals.org/. Default: 'full'. anyOf[2]; default: "full"
body.contentUse string Optional anyOf[2]; anyOf[1]; enum: ["reference"]
body.contentUse string Optional anyOf[2]; anyOf[2]; enum: ["full"]
body.crawlPurposes array Optional List of crawl purposes to respect Content-Signal directives in robots.txt. Allowed values: 'search', 'ai-input', 'ai-train'. Learn more: https://contentsignals.org/. Default: ['search', 'ai-input', 'ai-train']. anyOf[2]; default: ["search","ai-input","ai-train"]; minItems: 1; maxItems: 3
body.crawlPurposes[] — Optional anyOf[2]
body.crawlPurposes[] string Optional anyOf[2]; anyOf[1]; enum: ["search"]
body.crawlPurposes[] string Optional anyOf[2]; anyOf[2]; enum: ["ai-input"]
body.crawlPurposes[] string Optional anyOf[2]; anyOf[3]; enum: ["ai-train"]
body.depth number Optional Maximum number of levels deep the crawler will traverse from the starting URL. anyOf[2]; default: 100000; minimum: 1; maximum: 100000
body.formats array Optional Formats to return. Default is html. anyOf[2]; default: ["html"]
body.formats[] — Optional anyOf[2]
body.formats[] string Optional anyOf[2]; anyOf[1]; enum: ["html"]
body.formats[] string Optional anyOf[2]; anyOf[2]; enum: ["markdown"]
body.formats[] string Optional anyOf[2]; anyOf[3]; enum: ["json"]
body.jsonOptions object Optional Options for JSON extraction. anyOf[2]; additionalProperties: false
body.jsonOptions.custom_ai array Optional Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback. anyOf[2]
body.jsonOptions.custom_ai[] object Optional anyOf[2]
body.jsonOptions.custom_ai[].authorization string Optional Authorization token for the AI model: Bearer &lt;token&gt;. Not needed for workers-ai models. anyOf[2]
body.jsonOptions.custom_ai[].model string Required AI model to use for the request. Must be formed as &lt;provider&gt;/&lt;model_name&gt;, e.g. workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast. anyOf[2]
body.jsonOptions.prompt string Optional anyOf[2]
body.jsonOptions.response_format object Optional anyOf[2]
body.jsonOptions.response_format.json_schema object | null Optional Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/ anyOf[2]; additionalProperties: true
body.jsonOptions.response_format.type string Required anyOf[2]
body.limit number Optional Maximum number of URLs to crawl. anyOf[2]; default: 10; minimum: 1; maximum: 100000
body.maxAge number Optional Maximum age of a resource that can be returned from cache in seconds. Default is 1 day. anyOf[2]; default: 86400; minimum: 0; maximum: 604800
body.modifiedSince integer Optional Unix timestamp (seconds since epoch) indicating to only crawl pages that were modified since this time. For sitemap URLs with a lastmod field, this is compared directly. For other URLs, the crawler will use If-Modified-Since header when fetching. URLs without modification information (no lastmod in sitemap and no Last-Modified header support) will be crawled. Note: This works in conjunction with maxAge - both filters must pass for a cached resource to be used. Must be within the last year and not in the future. anyOf[2]; exclusiveMinimum: 0
body.options object Optional Additional options for the crawler. anyOf[2]; default: {"includeExternalLinks":false,"includeSubdomains":false}
body.options.excludePatterns array Optional Exclude links matching the provided wildcard patterns in the crawl job. Example: 'https://example.com/privacy/**'. anyOf[2]; maxItems: 100
body.options.excludePatterns[] string Optional anyOf[2]; minLength: 1; maxLength: 500
body.options.includeExternalLinks boolean Optional Include external links in the crawl job. If set to true, includeSubdomains is ignored. anyOf[2]; default: false
body.options.includePatterns array Optional Include only links matching the provided wildcard patterns in the crawl job. Include patterns are evaluated before exclude patterns. URLs that match any of the specified include patterns will be included in the crawl job. Example: 'https://example.com/blog/**'. anyOf[2]; maxItems: 100
body.options.includePatterns[] string Optional anyOf[2]; minLength: 1; maxLength: 500
body.options.includeSubdomains boolean Optional Include links to subdomains in the crawl job. This option is ignored if includeExternalLinks is true. anyOf[2]; default: false
body.render boolean Required Whether to render the page or fetch static content. True by default. anyOf[2]; enum: [false]
body.source — Optional Source of links to crawl. 'sitemaps' - only crawl URLs from sitemaps, 'links' - only crawl URLs scraped from pages, 'all' - crawl both sitemap and scraped links (default). anyOf[2]; default: "all"
body.source string Optional anyOf[2]; anyOf[1]; enum: ["sitemaps"]
body.source string Optional anyOf[2]; anyOf[2]; enum: ["links"]
body.source string Optional anyOf[2]; anyOf[3]; enum: ["all"]
body.url string Required URL to navigate to, eg. https://example.com. anyOf[2]; format: "uri"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a crawl job. — cloudflare.brapi-delete_cancelcrawl

Cancels an ongoing crawl job by setting its status to cancelled and stopping all queued URLs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.job_id string Required The ID of the crawl job to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get crawl result. — cloudflare.brapi-get_crawlresult

Returns the result of a crawl job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.job_id string Required Crawl job ID. minLength: 1
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.status string Optional Filter by URL status. enum: ["queued","errored","completed","disallowed","skipped","cancelled"]
query.cursor number Optional Cursor for pagination. default: 0
query.limit number Optional Limit for pagination. default: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a browser session ID. — cloudflare.brapi-post_devtoolsacquire

Acquires a browser and returns its session ID and websocket URL. Optionally accepts a JSON body with session guardrails to restrict outbound HTTP/S traffic.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.keep_alive number Optional Keep-alive time in milliseconds. default: 60000; minimum: 10000; maximum: 1200000
query.lab boolean Optional Use experimental browser. default: false
query.targets boolean Optional Include browser targets in response. default: false
query.liveViewUrlExpiresInMs number Optional How long the live view URL remains valid, in milliseconds (max 60 minutes). Only used when targets is true. default: 300000; minimum: 60000; maximum: 3600000
query.recording boolean Optional default: false
body object Optional additionalProperties: false
body.guardrails object Optional additionalProperties: false
body.guardrails.allowedDomainSets array Optional Max 4 entries: curated preset names (common-cdns) and/or https URLs of newline-separated hostname lists. maxItems: 4
body.guardrails.allowedDomainSets[] string Optional
body.guardrails.allowedDomains array Optional Hostname patterns, max 50. Supports exact hosts (example.com) or a single * wildcard anywhere. Prefer *.example.com (subdomain wildcard) over *example.com (prefix wildcard) to avoid matching overbroad lookalikes like evilexample.com. maxItems: 50
body.guardrails.allowedDomains[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Close browser session. — cloudflare.brapi-delete_devtoolsbrowserdelete

Closes an existing browser session.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID to close. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List targets. — cloudflare.brapi-get_devtoolsjson

Returns a list of all debuggable targets including tabs, pages, service workers, and other browser contexts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID. format: "uuid"
query object Optional additionalProperties: false
query.liveViewUrlExpiresInMs number Optional How long the live view URLs remain valid, in milliseconds (max 60 minutes) default: 300000; minimum: 60000; maximum: 3600000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Activate a browser target. — cloudflare.brapi-get_devtoolsjsonactivate

Activates (brings to front) a specific browser target by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required Browser session ID. format: "uuid"
path.account_id string Required Account ID.
path.target_id string Required Target ID to activate. pattern: "^[a-zA-Z0-9]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example",
    "target_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Close a browser target. — cloudflare.brapi-get_devtoolsjsonclose

Closes a specific browser target (tab, page, etc.) by its ID. Returns 'Target is closing' on success or an error if the target is not found.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required Browser session ID. format: "uuid"
path.account_id string Required Account ID.
path.target_id string Required Target ID to close. pattern: "^[a-zA-Z0-9]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example",
    "target_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List targets. — cloudflare.brapi-get_devtoolsjsonlist

Returns a list of all debuggable targets including tabs, pages, service workers, and other browser contexts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID. format: "uuid"
query object Optional additionalProperties: false
query.liveViewUrlExpiresInMs number Optional How long the live view URLs remain valid, in milliseconds (max 60 minutes) default: 300000; minimum: 60000; maximum: 3600000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a target by ID. — cloudflare.brapi-get_devtoolsjsontarget

Returns the debuggable target with the given ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID. format: "uuid"
path.target_id string Required Target ID. pattern: "^[a-zA-Z0-9]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000",
    "target_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Open a new browser tab. — cloudflare.brapi-put_devtoolsjsonnew

Opens a new tab in the browser. Optionally specify a URL to navigate to.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID. format: "uuid"
query object Optional additionalProperties: false
query.url string Optional format: "uri"
query.liveViewUrlExpiresInMs number Optional How long the live view URL remains valid, in milliseconds (max 60 minutes) default: 300000; minimum: 60000; maximum: 3600000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Chrome DevTools Protocol schema. — cloudflare.brapi-get_devtoolsjsonprotocol

Returns the complete Chrome DevTools Protocol schema including all domains, commands, events, and types. This schema describes the entire CDP API surface.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get browser version metadata. — cloudflare.brapi-get_devtoolsjsonversion

Get browser version metadata.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mint live view URLs for a browser session — cloudflare.brapi-post_devtoolsliveview

Generates time-limited URLs to view a remote browser session. Set guardrails: { mode: 'readonly' } to create a view-only link.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Browser session ID format: "uuid"
body object Optional
body.expiresInMs number Optional How long the live view URLs remain valid, in milliseconds. Default: 5 minutes. Max: 60 minutes. default: 300000; minimum: 60000; maximum: 3600000
body.guardrails object Optional Connection guardrails. Use { mode: 'readonly' } to generate a view-only link. additionalProperties: false
body.guardrails.mode string Required enum: ["readonly"]
body.mode string Optional UI mode: 'devtools' (Chrome DevTools), 'tab' (single tab view), 'full' (multi-tab browser) enum: ["devtools","tab","full"]; default: "devtools"
body.targetId string Optional Target ID (page) to connect to. If omitted, auto-resolves to the first active page. pattern: "^[a-fA-F0-9]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List sessions. — cloudflare.brapi-get_devtoolssessionlist

List active browser sessions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.limit number Optional default: 200; minimum: 1; maximum: 200
query.offset number Optional default: 0; minimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get session details. — cloudflare.brapi-get_devtoolssessiondetails

Get details for a specific browser session.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Session ID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get json. — cloudflare.brapi-post_json

Gets json from a webpage from a provided URL or HTML. Pass prompt or schema in the body. Control page loading with gotoOptions and waitFor options.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.custom_ai array Optional Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback.
body.custom_ai[] object Optional
body.custom_ai[].authorization string Optional Authorization token for the AI model: Bearer &lt;token&gt;. Not needed for workers-ai models.
body.custom_ai[].model string Required AI model to use for the request. Must be formed as &lt;provider&gt;/&lt;model_name&gt;, e.g. workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast.
body.emulateMediaType string Optional
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.prompt string Optional
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.response_format object Optional
body.response_format.json_schema object | null Optional Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/ additionalProperties: true
body.response_format.type string Required
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Links. — cloudflare.brapi-post_links

Get links from a web page.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.emulateMediaType string Optional
body.excludeExternalLinks boolean Optional default: false
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.visibleLinksOnly boolean Optional default: false
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get markdown. — cloudflare.brapi-post_markdown

Gets markdown of a webpage from provided URL or HTML. Control page loading with gotoOptions and waitFor options.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.emulateMediaType string Optional
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get PDF. — cloudflare.brapi-post_pdf

Fetches rendered PDF from provided URL or HTML. Check available options like gotoOptions and waitFor to control page load behaviour.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.emulateMediaType string Optional
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.pdfOptions object Optional Check options. default: {}; additionalProperties: false
body.pdfOptions.displayHeaderFooter boolean Optional Whether to show the header and footer. default: false
body.pdfOptions.footerTemplate string Optional HTML template for the print footer.
body.pdfOptions.format string Optional Paper format. Takes priority over width and height if set. enum: ["letter","legal","tabloid","ledger","a0","a1","a2","a3","a4","a5","a6"]; default: "letter"
body.pdfOptions.headerTemplate string Optional HTML template for the print header.
body.pdfOptions.height — Optional Sets the height of paper. Can be a number or string with unit.
body.pdfOptions.height string Optional anyOf[1]
body.pdfOptions.height number Optional anyOf[2]
body.pdfOptions.landscape boolean Optional Whether to print in landscape orientation. default: false
body.pdfOptions.margin object Optional Set the PDF margins. Useful when setting header and footer.
body.pdfOptions.margin.bottom — Optional
body.pdfOptions.margin.bottom string Optional anyOf[1]
body.pdfOptions.margin.bottom number Optional anyOf[2]
body.pdfOptions.margin.left — Optional
body.pdfOptions.margin.left string Optional anyOf[1]
body.pdfOptions.margin.left number Optional anyOf[2]
body.pdfOptions.margin.right — Optional
body.pdfOptions.margin.right string Optional anyOf[1]
body.pdfOptions.margin.right number Optional anyOf[2]
body.pdfOptions.margin.top — Optional
body.pdfOptions.margin.top string Optional anyOf[1]
body.pdfOptions.margin.top number Optional anyOf[2]
body.pdfOptions.omitBackground boolean Optional Hides default white background and allows generating pdfs with transparency. default: false
body.pdfOptions.outline boolean Optional Generate document outline. default: false
body.pdfOptions.pageRanges string Optional Paper ranges to print, e.g. '1-5, 8, 11-13'.
body.pdfOptions.preferCSSPageSize boolean Optional Give CSS @page size priority over other size declarations. default: false
body.pdfOptions.printBackground boolean Optional Set to true to print background graphics. default: false
body.pdfOptions.scale number Optional Scales the rendering of the web page. Amount must be between 0.1 and 2. default: 1; minimum: 0.1; maximum: 2
body.pdfOptions.tagged boolean Optional Generate tagged (accessible) PDF. default: true
body.pdfOptions.timeout number Optional Timeout in milliseconds. default: 30000
body.pdfOptions.width — Optional Sets the width of paper. Can be a number or string with unit.
body.pdfOptions.width string Optional anyOf[1]
body.pdfOptions.width number Optional anyOf[2]
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get recording data. — cloudflare.brapi-get_recording

Returns the recording data for a given session as a dictionary of events per targetId.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Session ID. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get network recording data. — cloudflare.brapi-get_recordingnetwork

Returns network recording events for the requested target ID. Use ?format=har for a HAR JSON document.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.session_id string Required Session ID. minLength: 1
query object Required additionalProperties: false
query.format string Optional Set to har to return a HAR JSON document.
query.target string Required Target ID to include in the response. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "session_id": "example"
  },
  "query": {
    "target": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Scrape elements. — cloudflare.brapi-post_scrape

Get meta attributes like height, width, text and others of selected elements.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.elements array Required minItems: 1
body.elements[] object Optional
body.elements[].selector string Required
body.emulateMediaType string Optional
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "elements": [
      {
        "selector": "h1"
      }
    ],
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get screenshot. — cloudflare.brapi-post_screenshot

Takes a screenshot of a webpage from provided URL or HTML. Control page loading with gotoOptions and waitFor options. Customize screenshots with viewport, fullPage, clip and others.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.emulateMediaType string Optional
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.screenshotOptions object Optional Check options. default: {}; additionalProperties: false
body.screenshotOptions.captureBeyondViewport boolean Optional
body.screenshotOptions.clip object Optional
body.screenshotOptions.clip.height number Required
body.screenshotOptions.clip.scale number Optional
body.screenshotOptions.clip.width number Required
body.screenshotOptions.clip.x number Required
body.screenshotOptions.clip.y number Required
body.screenshotOptions.encoding — Optional default: "binary"
body.screenshotOptions.encoding string Optional anyOf[1]; enum: ["binary"]
body.screenshotOptions.encoding string Optional anyOf[2]; enum: ["base64"]
body.screenshotOptions.fromSurface boolean Optional
body.screenshotOptions.fullPage boolean Optional
body.screenshotOptions.omitBackground boolean Optional
body.screenshotOptions.optimizeForSpeed boolean Optional
body.screenshotOptions.quality number Optional
body.screenshotOptions.type — Optional default: "png"
body.screenshotOptions.type string Optional anyOf[1]; enum: ["png"]
body.screenshotOptions.type string Optional anyOf[2]; enum: ["jpeg"]
body.screenshotOptions.type string Optional anyOf[3]; enum: ["webp"]
body.scrollPage boolean Optional
body.selector string Optional
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get HTML content and screenshot. — cloudflare.brapi-post_snapshot

Returns the page's HTML content and screenshot. Control page loading with gotoOptions and waitFor options. Customize screenshots with viewport, fullPage, clip and others.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cacheTTL number Optional Cache TTL default is 5s. Set to 0 to disable. default: 5; minimum: 0; maximum: 86400
query.browser string Optional Rendering backend. Set to kitesurf to use Kitesurf (beta). enum: ["kitesurf"]
body object Required additionalProperties: false
body.actionTimeout number Optional The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum: 120000
body.addScriptTag array Optional Adds a script element into the page with the desired URL or content.
body.addScriptTag[] object Optional additionalProperties: false
body.addScriptTag[].content string Optional
body.addScriptTag[].id string Optional
body.addScriptTag[].type string Optional
body.addScriptTag[].url string Optional format: "uri"
body.addStyleTag array Optional Adds a `` tag into the page with the desired URL or a `
body.addStyleTag[] object Optional
body.addStyleTag[].content string Optional
body.addStyleTag[].url string Optional format: "uri"
body.allowRequestPattern array Optional Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'. Reject rules are applied first.
body.allowRequestPattern[] string Optional
body.allowResourceTypes array Optional Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
body.allowResourceTypes[] — Optional
body.allowResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.allowResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.allowResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.allowResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.allowResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.allowResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.allowResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.allowResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.allowResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.allowResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.allowResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.allowResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.allowResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.allowResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.allowResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.allowResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.allowResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.allowResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.authenticate object Optional Provide credentials for HTTP authentication.
body.authenticate.password string Required minLength: 1
body.authenticate.username string Required minLength: 1
body.bestAttempt boolean Optional Attempt to proceed when 'awaited' events fail or timeout.
body.cookies array Optional Check options.
body.cookies[] object Optional
body.cookies[].domain string Optional
body.cookies[].expires number Optional
body.cookies[].httpOnly boolean Optional
body.cookies[].name string Required Cookie name.
body.cookies[].partitionKey string Optional
body.cookies[].path string Optional
body.cookies[].priority — Optional
body.cookies[].priority string Optional anyOf[1]; enum: ["Low"]
body.cookies[].priority string Optional anyOf[2]; enum: ["Medium"]
body.cookies[].priority string Optional anyOf[3]; enum: ["High"]
body.cookies[].sameParty boolean Optional
body.cookies[].sameSite — Optional
body.cookies[].sameSite string Optional anyOf[1]; enum: ["Strict"]
body.cookies[].sameSite string Optional anyOf[2]; enum: ["Lax"]
body.cookies[].sameSite string Optional anyOf[3]; enum: ["None"]
body.cookies[].secure boolean Optional
body.cookies[].sourcePort number Optional
body.cookies[].sourceScheme — Optional
body.cookies[].sourceScheme string Optional anyOf[1]; enum: ["Unset"]
body.cookies[].sourceScheme string Optional anyOf[2]; enum: ["NonSecure"]
body.cookies[].sourceScheme string Optional anyOf[3]; enum: ["Secure"]
body.cookies[].url string Optional
body.cookies[].value string Required
body.emulateMediaType string Optional
body.formats array Optional default: ["content","screenshot"]
body.formats[] string Optional enum: ["content","screenshot","markdown","accessibilityTree"]
body.gotoOptions object Optional Check options. default: {}
body.gotoOptions.referer string Optional
body.gotoOptions.referrerPolicy string Optional
body.gotoOptions.timeout number Optional default: 30000; maximum: 60000
body.gotoOptions.waitUntil — Optional default: "domcontentloaded"
body.gotoOptions.waitUntil string Optional anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil string Optional anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil string Optional anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil string Optional anyOf[4]; enum: ["networkidle2"]
body.gotoOptions.waitUntil array Optional anyOf[5]
body.gotoOptions.waitUntil[] — Optional anyOf[5]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[1]; enum: ["load"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[2]; enum: ["domcontentloaded"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[3]; enum: ["networkidle0"]
body.gotoOptions.waitUntil[] string Optional anyOf[5]; anyOf[4]; enum: ["networkidle2"]
body.html string Optional Set the content of the page, eg: Hello World!! . Either html or url must be set. minLength: 1
body.rejectRequestPattern array Optional Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.
body.rejectRequestPattern[] string Optional
body.rejectResourceTypes array Optional Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
body.rejectResourceTypes[] — Optional
body.rejectResourceTypes[] string Optional anyOf[1]; enum: ["document"]
body.rejectResourceTypes[] string Optional anyOf[2]; enum: ["stylesheet"]
body.rejectResourceTypes[] string Optional anyOf[3]; enum: ["image"]
body.rejectResourceTypes[] string Optional anyOf[4]; enum: ["media"]
body.rejectResourceTypes[] string Optional anyOf[5]; enum: ["font"]
body.rejectResourceTypes[] string Optional anyOf[6]; enum: ["script"]
body.rejectResourceTypes[] string Optional anyOf[7]; enum: ["texttrack"]
body.rejectResourceTypes[] string Optional anyOf[8]; enum: ["xhr"]
body.rejectResourceTypes[] string Optional anyOf[9]; enum: ["fetch"]
body.rejectResourceTypes[] string Optional anyOf[10]; enum: ["prefetch"]
body.rejectResourceTypes[] string Optional anyOf[11]; enum: ["eventsource"]
body.rejectResourceTypes[] string Optional anyOf[12]; enum: ["websocket"]
body.rejectResourceTypes[] string Optional anyOf[13]; enum: ["manifest"]
body.rejectResourceTypes[] string Optional anyOf[14]; enum: ["signedexchange"]
body.rejectResourceTypes[] string Optional anyOf[15]; enum: ["ping"]
body.rejectResourceTypes[] string Optional anyOf[16]; enum: ["cspviolationreport"]
body.rejectResourceTypes[] string Optional anyOf[17]; enum: ["preflight"]
body.rejectResourceTypes[] string Optional anyOf[18]; enum: ["other"]
body.screenshotOptions object Optional default: {}; additionalProperties: false
body.screenshotOptions.captureBeyondViewport boolean Optional
body.screenshotOptions.clip object Optional
body.screenshotOptions.clip.height number Required
body.screenshotOptions.clip.scale number Optional
body.screenshotOptions.clip.width number Required
body.screenshotOptions.clip.x number Required
body.screenshotOptions.clip.y number Required
body.screenshotOptions.fromSurface boolean Optional
body.screenshotOptions.fullPage boolean Optional
body.screenshotOptions.omitBackground boolean Optional
body.screenshotOptions.optimizeForSpeed boolean Optional
body.screenshotOptions.quality number Optional
body.screenshotOptions.type — Optional default: "png"
body.screenshotOptions.type string Optional anyOf[1]; enum: ["png"]
body.screenshotOptions.type string Optional anyOf[2]; enum: ["jpeg"]
body.screenshotOptions.type string Optional anyOf[3]; enum: ["webp"]
body.setExtraHTTPHeaders object Optional additionalProperties: {"type":"string"}
body.setJavaScriptEnabled boolean Optional
body.url string Optional URL to navigate to, eg. https://example.com. format: "uri"
body.userAgent string Optional default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
body.viewport object Optional Check options. default: {"height":1080,"width":1920}
body.viewport.deviceScaleFactor number Optional
body.viewport.hasTouch boolean Optional
body.viewport.height number Required
body.viewport.isLandscape boolean Optional
body.viewport.isMobile boolean Optional
body.viewport.width number Required
body.waitForSelector object Optional Wait for the selector to appear in page. Check options.
body.waitForSelector.hidden boolean Optional enum: [true]
body.waitForSelector.selector string Required
body.waitForSelector.timeout number Optional maximum: 120000
body.waitForSelector.visible boolean Optional enum: [true]
body.waitForTimeout number Optional Waits for a specified timeout before continuing. maximum: 120000
body object Required oneOf[1]
body.html string Optional oneOf[1]
body.url string Required oneOf[1]
body object Required oneOf[2]
body.html string Required oneOf[2]
body.url string Optional oneOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "formats": [
      "content",
      "screenshot"
    ],
    "url": "https://www.example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get build-minute availability — cloudflare.getaccountlimits

Return whether the account's build-minute allowance is exhausted and when it refreshes.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get builds by Worker version — cloudflare.getbuildsbyversionids

Retrieve builds associated with one or more Worker version IDs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
query object Required additionalProperties: false
query.version_ids — Required $ref: "#/definitions/builds_version_ids"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "query": {
    "version_ids": "123e4567-e89b-12d3-a456-426614174000,223e4567-e89b-12d3-a456-426614174001"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get latest builds by script IDs — cloudflare.getlatestbuildsbyscripts

Retrieve the most recent builds for multiple worker scripts

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
query object Required additionalProperties: false
query.external_script_ids — Required $ref: "#/definitions/builds_external_script_ids"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "query": {
    "external_script_ids": "dd7160bb9cef458093557736f4b9e75b,42fb14fe81df47139d3be684e4c637a6,ff7cf9a7582f4c0d90a4b95cb17d659e"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Workers build — cloudflare.getbuildbyuuid

Retrieve status, outcome, timestamps, trigger settings, and source metadata for a build UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.build_uuid — Required $ref: "#/definitions/builds_build_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "build_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a Workers build — cloudflare.cancelbuildbyuuid

Cancel a queued or running build.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.build_uuid — Required $ref: "#/definitions/builds_build_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "build_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers build logs — cloudflare.getbuildlogs

Retrieve cursor-paginated log lines for a build UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.build_uuid — Required $ref: "#/definitions/builds_build_uuid"
query object Optional additionalProperties: false
query.cursor — Optional $ref: "#/definitions/builds_cursor"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "build_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a repository connection — cloudflare.upsertrepoconnection

Save the repository connection required by build triggers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
body — Required $ref: "#/definitions/builds_UpsertRepoConnectionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "body": {
    "repo_id": "workers-sdk",
    "repo_name": "workers-sdk",
    "provider_type": "github",
    "provider_account_id": "cloudflare",
    "provider_account_name": "Cloudflare"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a repository connection — cloudflare.deleterepoconnection

Delete a saved repository connection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.repo_connection_uuid — Required $ref: "#/definitions/builds_repo_connection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "repo_connection_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repository configuration autofill — cloudflare.getworkerconfigautofill

Analyze repository for automatic configuration detection

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.provider_type — Required SCM provider type $ref: "#/definitions/builds_SCMProviderType"
path.provider_account_id — Required $ref: "#/definitions/builds_provider_account_id"
path.repo_id — Required $ref: "#/definitions/builds_repo_id"
query object Required additionalProperties: false
query.branch — Required $ref: "#/definitions/builds_branch"
query.root_directory — Optional $ref: "#/definitions/builds_root_directory"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "provider_type": "github",
    "provider_account_id": "cloudflare",
    "repo_id": "workers-sdk"
  },
  "query": {
    "branch": "main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List build tokens — cloudflare.listbuildtokens

List metadata for build tokens available to the current user without returning their secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
query object Optional additionalProperties: false
query.page integer Optional Page number for pagination default: 1; minimum: 1
query.per_page integer Optional Number of items per page default: 50; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create build token — cloudflare.createbuildtoken

Create a new build authentication token

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
body — Required $ref: "#/definitions/builds_CreateBuildTokenRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "body": {
    "build_token_name": "My Build Token",
    "build_token_secret": "super-secret-token",
    "cloudflare_token_id": "cf-token-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a build token — cloudflare.deletebuildtoken

Delete a stored build token owned by the current user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.build_token_uuid — Required $ref: "#/definitions/builds_build_token_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "build_token_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a build trigger — cloudflare.createtrigger

Create a trigger defining the repository connection, Worker tag, commands, filters, cache setting, and build token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
body — Required $ref: "#/definitions/builds_CreateTriggerRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "body": {
    "external_script_id": "dd7160bb9cef458093557736f4b9e75b",
    "build_token_uuid": "00000000-0000-4000-8000-000000000000",
    "trigger_name": "Production Deploy",
    "build_command": "npm run build",
    "deploy_command": "npx wrangler deploy",
    "root_directory": "/",
    "branch_includes": [
      "main"
    ],
    "branch_excludes": [],
    "path_includes": [
      "*"
    ],
    "path_excludes": [
      "*.md"
    ],
    "repo_connection_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a build trigger — cloudflare.deletetrigger

Delete a trigger and cancel its unfinished builds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.trigger_uuid — Required $ref: "#/definitions/builds_trigger_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "trigger_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a build trigger — cloudflare.updatetrigger

Update commands, cache settings, or branch and path filters for a trigger.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.trigger_uuid — Required $ref: "#/definitions/builds_trigger_uuid"
body — Required $ref: "#/definitions/builds_UpdateTriggerRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "trigger_uuid": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a Workers build — cloudflare.createmanualbuild

Start a build for a branch or commit using the selected trigger.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.trigger_uuid — Required $ref: "#/definitions/builds_trigger_uuid"
body — Required $ref: "#/definitions/builds_CreateBuildRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "trigger_uuid": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "commit_hash": "abc123def456"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List build variables — cloudflare.listenvironmentvariables

List build-time variables configured for a trigger. Secret values are not returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.trigger_uuid — Required $ref: "#/definitions/builds_trigger_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "trigger_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set build variables — cloudflare.upsertenvironmentvariables

Add or replace build-time variables and secrets without changing unspecified keys.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.trigger_uuid — Required $ref: "#/definitions/builds_trigger_uuid"
body — Required $ref: "#/definitions/builds_EnvironmentVariablesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "trigger_uuid": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "API_KEY": {
      "is_secret": true,
      "value": "secret-key"
    },
    "NODE_ENV": {
      "is_secret": false,
      "value": "production"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a build variable — cloudflare.deleteenvironmentvariable

Delete one build-time variable or secret by key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.trigger_uuid — Required $ref: "#/definitions/builds_trigger_uuid"
path.environment_variable_key — Required $ref: "#/definitions/builds_environment_variable_key"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "trigger_uuid": "00000000-0000-4000-8000-000000000000",
    "environment_variable_key": "NODE_ENV"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge a trigger's build cache — cloudflare.purgebuildcache

Delete cached dependencies and build artifacts associated with a trigger.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.trigger_uuid — Required $ref: "#/definitions/builds_trigger_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "trigger_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Worker build configuration — cloudflare.createworkerbuild

Connect a Worker tag to a repository and production build settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
body — Required $ref: "#/definitions/builds_CreateWorkerRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "body": {
    "script_tag": "dd7160bb9cef458093557736f4b9e75b",
    "git_repository": {
      "repo_id": "workers-sdk",
      "repo_name": "workers-sdk",
      "provider_type": "github",
      "provider_account_id": "cloudflare",
      "provider_account_name": "Cloudflare",
      "branch": "main"
    },
    "production_settings": {
      "build_command": "npm run build",
      "deploy_command": "npx wrangler deploy",
      "build_token_uuid": "00000000-0000-4000-8000-000000000000"
    },
    "previews_enabled": false,
    "previews_base_config": {
      "build_command": "npm run build",
      "deploy_command": "npx wrangler deploy",
      "build_token_uuid": "00000000-0000-4000-8000-000000000000"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List builds for a Worker — cloudflare.listbuildsbyscript

List paginated build records associated with a Worker tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.external_script_id — Required $ref: "#/definitions/builds_external_script_id"
query object Optional additionalProperties: false
query.page integer Optional Page number for pagination default: 1; minimum: 1
query.per_page integer Optional Number of items per page default: 50; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "external_script_id": "dd7160bb9cef458093557736f4b9e75b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List triggers for a Worker — cloudflare.listtriggersbyscript

List trigger UUIDs and build settings associated with a Worker tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.external_script_id — Required $ref: "#/definitions/builds_external_script_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "external_script_id": "dd7160bb9cef458093557736f4b9e75b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deploy hooks — cloudflare.listdeployhooks

List the branch-specific deploy hooks configured for a Worker.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_name — Required Human-readable name of the worker. $ref: "#/definitions/builds_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_name": "my-worker"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a deploy hook — cloudflare.createdeployhook

Create an HTTP hook that starts a build for a selected Worker branch.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_name — Required Human-readable name of the worker. $ref: "#/definitions/builds_script_name"
body — Required $ref: "#/definitions/builds_CreateDeployHookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_name": "my-worker"
  },
  "body": {
    "deploy_hook_name": "Production Deploy Hook",
    "branch": "main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a deploy hook — cloudflare.deletedeployhook

Delete a deploy hook so its UUID can no longer start builds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_name — Required Human-readable name of the worker. $ref: "#/definitions/builds_script_name"
path.deploy_hook_uuid — Required Deploy hook UUID $ref: "#/definitions/builds_deploy_hook_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_name": "my-worker",
    "deploy_hook_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a deploy hook — cloudflare.getdeployhook

Retrieve the name, branch, Worker identifier, and timestamps for a deploy hook.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_name — Required Human-readable name of the worker. $ref: "#/definitions/builds_script_name"
path.deploy_hook_uuid — Required Deploy hook UUID $ref: "#/definitions/builds_deploy_hook_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_name": "my-worker",
    "deploy_hook_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a deploy hook — cloudflare.updatedeployhook

Replace the name and target branch for a deploy hook.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_name — Required Human-readable name of the worker. $ref: "#/definitions/builds_script_name"
path.deploy_hook_uuid — Required Deploy hook UUID $ref: "#/definitions/builds_deploy_hook_uuid"
body — Required $ref: "#/definitions/builds_CreateDeployHookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_name": "my-worker",
    "deploy_hook_uuid": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "deploy_hook_name": "Production Deploy Hook",
    "branch": "main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker build configuration — cloudflare.deleteworkerbuild

Delete build settings and triggers for a Worker tag and cancel unfinished builds. The Worker is not deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_tag — Required The Worker script tag (external script ID) $ref: "#/definitions/builds_external_script_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_tag": "dd7160bb9cef458093557736f4b9e75b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker build configuration — cloudflare.getworkerbuild

Retrieve the repository and production build settings associated with a Worker tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_tag — Required The Worker script tag (external script ID) $ref: "#/definitions/builds_external_script_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_tag": "dd7160bb9cef458093557736f4b9e75b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Migrate worker to previews — cloudflare.migrateworkertopreviews

Migrate a Worker's legacy non-production trigger to Previews. The legacy build settings become the Previews base config and the legacy trigger is removed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_tag — Required The Worker script tag (external script ID) $ref: "#/definitions/builds_external_script_id"
body — Required $ref: "#/definitions/builds_MigrateToPreviewsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_tag": "dd7160bb9cef458093557736f4b9e75b"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List previews — cloudflare.listworkerpreviews

List the Previews of a Worker with pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_tag — Required The Worker script tag (external script ID) $ref: "#/definitions/builds_external_script_id"
query object Optional additionalProperties: false
query.page integer Optional Page number for pagination default: 1; minimum: 1
query.per_page integer Optional Number of items per page default: 50; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_tag": "dd7160bb9cef458093557736f4b9e75b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get preview — cloudflare.getworkerpreview

Retrieve a single Preview of a Worker, including the build settings it currently uses.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_tag — Required The Worker script tag (external script ID) $ref: "#/definitions/builds_external_script_id"
path.preview_id — Required The script tag of the Preview, which is a Worker in its own right $ref: "#/definitions/builds_external_script_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_tag": "dd7160bb9cef458093557736f4b9e75b",
    "preview_id": "dd7160bb9cef458093557736f4b9e75b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List builds by preview — cloudflare.listbuildsbypreview

List the builds of a single Preview with pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_tag — Required The Worker script tag (external script ID) $ref: "#/definitions/builds_external_script_id"
path.preview_id — Required The script tag of the Preview, which is a Worker in its own right $ref: "#/definitions/builds_external_script_id"
query object Optional additionalProperties: false
query.page integer Optional Page number for pagination default: 1; minimum: 1
query.per_page integer Optional Number of items per page default: 50; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_tag": "dd7160bb9cef458093557736f4b9e75b",
    "preview_id": "dd7160bb9cef458093557736f4b9e75b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create preview build — cloudflare.createpreviewbuild

Trigger a build for a single Preview.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/builds_account_id"
path.script_tag — Required The Worker script tag (external script ID) $ref: "#/definitions/builds_external_script_id"
path.preview_id — Required The script tag of the Preview, which is a Worker in its own right $ref: "#/definitions/builds_external_script_id"
body — Required $ref: "#/definitions/builds_CreateBuildRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "script_tag": "dd7160bb9cef458093557736f4b9e75b",
    "preview_id": "dd7160bb9cef458093557736f4b9e75b"
  },
  "body": {
    "commit_hash": "abc123def456"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Subscriptions — cloudflare.account-subscriptions-bulk-create-subscription

Creates multiple subscriptions for an account in a single request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
query object Optional additionalProperties: false
query.idemp_key string Optional
body object Required
body.coupon_code string Optional
body.payment_hold_id integer Optional
body.subscriptions array Optional
body.subscriptions[] — Optional $ref: "#/definitions/bill-subs-api_subscription-v2"
body.user_is_on_session boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List apps — cloudflare.calls-apps-list

Lists all apps in the Cloudflare account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/calls_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an SFU app — cloudflare.calls-apps-create-a-new-app

Creates a Realtime SFU app. An app is an isolated namespace in which sessions can access the app's tracks.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/calls_account_identifier"
body — Required $ref: "#/definitions/calls_app_editable_fields"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an SFU app — cloudflare.calls-apps-delete-app

Deletes a Realtime SFU app.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/calls_identifier"
path.account_id — Required $ref: "#/definitions/calls_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "2a95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve SFU app details — cloudflare.calls-apps-retrieve-app-details

Fetches details for a single Realtime SFU app.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/calls_identifier"
path.account_id — Required $ref: "#/definitions/calls_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "2a95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update SFU app details — cloudflare.calls-apps-update-app-details

Updates details for a single Realtime SFU app.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/calls_identifier"
path.account_id — Required $ref: "#/definitions/calls_account_identifier"
body — Required $ref: "#/definitions/calls_app_editable_fields"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "2a95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List TURN keys — cloudflare.calls-turn-key-list

Lists all TURN keys in the Cloudflare account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/calls_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a TURN key — cloudflare.calls-turn-key-create

Creates a new Realtime TURN key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/calls_account_identifier"
body — Required $ref: "#/definitions/calls_turn_key_editable_fields"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete TURN key — cloudflare.calls-delete-turn-key

Deletes a Realtime TURN key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id — Required $ref: "#/definitions/calls_identifier"
path.account_id — Required $ref: "#/definitions/calls_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "2a95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve TURN key details — cloudflare.calls-retrieve-turn-key-details

Fetches details for a single TURN key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id — Required $ref: "#/definitions/calls_identifier"
path.account_id — Required $ref: "#/definitions/calls_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "2a95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update TURN key details — cloudflare.calls-update-turn-key

Updates details for a single TURN key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id — Required $ref: "#/definitions/calls_identifier"
path.account_id — Required $ref: "#/definitions/calls_account_identifier"
body — Required $ref: "#/definitions/calls_turn_key_editable_fields"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "2a95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Cloudflare Tunnels — cloudflare.cloudflare-tunnel-list-cloudflare-tunnels

Lists and filters Cloudflare Tunnels in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.name — Optional $ref: "#/definitions/tunnel_tunnel_name"
query.is_deleted boolean Optional If true, only include deleted tunnels. If false, exclude deleted tunnels. If empty, all tunnels will be included.
query.existed_at — Optional $ref: "#/definitions/tunnel_existed_at"
query.uuid — Optional $ref: "#/definitions/tunnel_tunnel_id"
query.was_active_at string Optional format: "date-time"
query.was_inactive_at string Optional format: "date-time"
query.include_prefix string Optional
query.exclude_prefix string Optional
query.status — Optional $ref: "#/definitions/tunnel_status"
query.per_page — Optional $ref: "#/definitions/tunnel_per_page"
query.page — Optional $ref: "#/definitions/tunnel_page_number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-create-a-cloudflare-tunnel

Creates a remotely or locally managed Cloudflare Tunnel in an account. After creation, retrieve its token and run cloudflared to establish the connector connection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.config_src — Optional
body.config_src — Optional allOf[1]; $ref: "#/definitions/tunnel_config_src"
body.name — Required $ref: "#/definitions/tunnel_tunnel_name"
body.tunnel_secret — Optional $ref: "#/definitions/tunnel_tunnel_secret"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "blog"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-delete-a-cloudflare-tunnel

Permanently deletes a Cloudflare Tunnel from an account. The tunnel must have no active connections.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-get-a-cloudflare-tunnel

Fetches a single Cloudflare Tunnel.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Cloudflare Tunnel — cloudflare.cloudflare-tunnel-update-a-cloudflare-tunnel

Updates the name or secret of an existing Cloudflare Tunnel.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.name — Optional $ref: "#/definitions/tunnel_tunnel_name"
body.tunnel_secret — Optional $ref: "#/definitions/tunnel_tunnel_secret"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Tunnel configuration — cloudflare.cloudflare-tunnel-configuration-get-configuration

Retrieves the configuration for a remotely managed Cloudflare Tunnel.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_identifier"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Tunnel configuration — cloudflare.cloudflare-tunnel-configuration-put-configuration

Replaces the configuration for a remotely managed Cloudflare Tunnel, including its ingress rules and origin request settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_identifier"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id-2"
body object Required
body.config — Optional
body.config — Optional allOf[1]; $ref: "#/definitions/tunnel_config"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Clean up Cloudflare Tunnel connections — cloudflare.cloudflare-tunnel-clean-up-cloudflare-tunnel-connections

Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
query object Optional additionalProperties: false
query.client_id — Optional $ref: "#/definitions/tunnel_client_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Cloudflare Tunnel connections — cloudflare.cloudflare-tunnel-list-cloudflare-tunnel-connections

Lists the connections for a Cloudflare Tunnel, including connector IDs, cloudflared versions, and Cloudflare locations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cloudflare Tunnel connector — cloudflare.cloudflare-tunnel-get-cloudflare-tunnel-connector

Retrieves a connector and its connection details for a Cloudflare Tunnel, including its cloudflared version, architecture, and connected Cloudflare locations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
path.connector_id — Required $ref: "#/definitions/tunnel_client_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "connector_id": "1bedc50d-42b3-473c-b108-ff3d10c0d925"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Cloudflare Tunnel management token — cloudflare.cloudflare-tunnel-get-a-cloudflare-tunnel-management-token

Creates a short-lived management token for the requested Tunnel management resources, such as streaming logs. Treat the token as a secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
body object Required
body.resources array Required
body.resources[] — Optional $ref: "#/definitions/tunnel_management-resources"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "resources": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Cloudflare Tunnel token — cloudflare.cloudflare-tunnel-get-a-cloudflare-tunnel-token

Retrieves the token used to run cloudflared and associate it with a specific Cloudflare Tunnel. Treat the token as a secret.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Turnstile Widgets — cloudflare.accounts-turnstile-widgets-list

Lists Turnstile widgets for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/turnstile_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of items per page. default: 25; minimum: 5; maximum: 1000
query.order string Optional Field to order widgets by. enum: ["id","sitekey","name","created_on","modified_on"]
query.direction string Optional Direction to order widgets. enum: ["asc","desc"]
query.filter string Optional Filter widgets by field. The name field uses case-insensitive substring matching; sitekey uses exact matching. Format: field:value Supported fields: - name - Filter by widget name (e.g., filter=name:login-form) - sitekey - Filter by sitekey (e.g., filter=sitekey:0x4AAA) Returns 400 Bad Request if the field is unsupported or format is invalid. An empty filter value returns all results.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Turnstile Widget — cloudflare.accounts-turnstile-widget-create

Creates a Turnstile widget for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/turnstile_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of items per page. default: 25; minimum: 5; maximum: 1000
query.order string Optional Field to order widgets by. enum: ["id","sitekey","name","created_on","modified_on"]
query.direction string Optional Direction to order widgets. enum: ["asc","desc"]
query.filter string Optional Filter widgets by field. The name field uses case-insensitive substring matching; sitekey uses exact matching. Format: field:value Supported fields: - name - Filter by widget name (e.g., filter=name:login-form) - sitekey - Filter by sitekey (e.g., filter=sitekey:0x4AAA) Returns 400 Bad Request if the field is unsupported or format is invalid. An empty filter value returns all results.
body object Required
body.bot_fight_mode — Optional $ref: "#/definitions/turnstile_bot_fight_mode"
body.clearance_level — Optional $ref: "#/definitions/turnstile_clearance_level"
body.domains — Required $ref: "#/definitions/turnstile_domains"
body.ephemeral_id — Optional $ref: "#/definitions/turnstile_ephemeral_id"
body.mode — Required
body.mode — Required allOf[1]; $ref: "#/definitions/turnstile_widget_mode"
body.name — Required $ref: "#/definitions/turnstile_name"
body.offlabel — Optional $ref: "#/definitions/turnstile_offlabel"
body.region — Optional $ref: "#/definitions/turnstile_region"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "blog.cloudflare.com login form",
    "mode": "invisible",
    "domains": [
      "203.0.113.1",
      "cloudflare.com",
      "blog.example.com"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Turnstile Widget — cloudflare.accounts-turnstile-widget-delete

Deletes a Turnstile widget from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/turnstile_identifier"
path.sitekey — Required $ref: "#/definitions/turnstile_sitekey"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sitekey": "0x4AAF00AAAABn0R22HWm-YUc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Turnstile Widget Details — cloudflare.accounts-turnstile-widget-get

Returns the configuration of a Turnstile widget.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/turnstile_identifier"
path.sitekey — Required $ref: "#/definitions/turnstile_sitekey"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sitekey": "0x4AAF00AAAABn0R22HWm-YUc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Turnstile Widget — cloudflare.accounts-turnstile-widget-update

Updates the configuration of a Turnstile widget.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/turnstile_identifier"
path.sitekey — Required $ref: "#/definitions/turnstile_sitekey"
body object Required
body.bot_fight_mode — Optional $ref: "#/definitions/turnstile_bot_fight_mode"
body.clearance_level — Optional $ref: "#/definitions/turnstile_clearance_level"
body.domains — Required $ref: "#/definitions/turnstile_domains"
body.ephemeral_id — Optional $ref: "#/definitions/turnstile_ephemeral_id"
body.mode — Required
body.mode — Required allOf[1]; $ref: "#/definitions/turnstile_widget_mode"
body.name — Required $ref: "#/definitions/turnstile_name"
body.offlabel — Optional $ref: "#/definitions/turnstile_offlabel"
body.region — Optional $ref: "#/definitions/turnstile_region"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sitekey": "0x4AAF00AAAABn0R22HWm-YUc"
  },
  "body": {
    "name": "blog.cloudflare.com login form",
    "mode": "invisible",
    "domains": [
      "203.0.113.1",
      "cloudflare.com",
      "blog.example.com"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate Secret for a Turnstile Widget — cloudflare.accounts-turnstile-widget-rotate-secret

Generates a new secret key for this widget. If invalidate_immediately is set to false, the previous secret remains valid for 2 hours.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/turnstile_identifier"
path.sitekey — Required $ref: "#/definitions/turnstile_sitekey"
body object Required
body.invalidate_immediately — Optional $ref: "#/definitions/turnstile_invalidate_immediately"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sitekey": "0x4AAF00AAAABn0R22HWm-YUc"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Setup Intent — cloudflare.account-billing-create-setup-intent

Creates a Stripe setup intent for adding a payment method to an account. Returns a client secret for frontend payment method collection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Latest Banner Grab Result — cloudflare.get_getbanners

Retrieves the latest banner grab results for a Cloudforce One scan configuration, including service banners from open ports.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Defines the Account ID.
path.config_id string Required Defines the Config ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "config_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves a file from Binary Storage — cloudflare.get_bindbgetbinary

Retrieves a binary file from the Cloudforce One binary storage for analysis.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.hash string Required hash of the binary

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List events — cloudflare.get_eventlistget

Lists events, with filters passed as query parameters. datasetId accepts dataset UUIDs or one scope value used alone: all (or ) and operational select the intelligence datasets you can read, and analytics selects the analytics datasets you can read. A scope value covers at most 50 datasets. Without datasetId, the default Cloudforce One Threat Events dataset is used. To send filters in a JSON body instead, use threat-intel events search.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.cursor string Optional Cursor for pagination. When provided, filters are embedded in the cursor so you only need to pass cursor and pageSize. Returned in the previous response's result_info.cursor field. Use cursor-based pagination for deep pagination (beyond 100,000 records) or for optimal performance.
query.search array Optional default: []; maxItems: 10
query.search[] — Optional
query.search[] object Optional anyOf[1]; additionalProperties: false
query.search[].field string Required anyOf[1]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
query.search[].op string Required anyOf[1]; enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","find"]
query.search[].value string Required anyOf[1]; minLength: 1; maxLength: 512
query.search[] object Optional anyOf[2]; additionalProperties: false
query.search[].field string Required anyOf[2]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
query.search[].op string Required anyOf[2]; enum: ["in"]
query.search[].value array Required anyOf[2]; minItems: 1; maxItems: 100
query.search[].value[] string Optional anyOf[2]; minLength: 1; maxLength: 512
query.search[] object Optional anyOf[3]; additionalProperties: false
query.search[].field string Required anyOf[3]; enum: ["killChain"]
query.search[].op string Required anyOf[3]; enum: ["equals","not","gt","gte","lt","lte"]
query.search[].value — Required anyOf[3]
query.search[].value number Required anyOf[3]; anyOf[1]
query.search[].value string Required anyOf[3]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
query.search[] object Optional anyOf[4]; additionalProperties: false
query.search[].field string Required anyOf[4]; enum: ["killChain"]
query.search[].op string Required anyOf[4]; enum: ["in"]
query.search[].value array Required anyOf[4]; minItems: 1; maxItems: 100
query.search[].value[] — Optional anyOf[4]
query.search[].value[] number Optional anyOf[4]; anyOf[1]
query.search[].value[] string Optional anyOf[4]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
query.search[] object Optional anyOf[5]; additionalProperties: false
query.search[].field string Required anyOf[5]; enum: ["hasChildren"]
query.search[].op string Required anyOf[5]; enum: ["equals","not","gt","gte","lt","lte"]
query.search[].value — Required anyOf[5]
query.search[].value boolean Required anyOf[5]; anyOf[1]
query.search[].value string Required anyOf[5]; anyOf[2]; enum: ["true"]
query.search[].value string Required anyOf[5]; anyOf[3]; enum: ["false"]
query.search[].value number Required anyOf[5]; anyOf[4]; enum: [1]
query.search[].value number Required anyOf[5]; anyOf[5]; enum: [0]
query.search[].value string Required anyOf[5]; anyOf[6]; enum: ["1"]
query.search[].value string Required anyOf[5]; anyOf[7]; enum: ["0"]
query.search[] object Optional anyOf[6]; additionalProperties: false
query.search[].field string Required anyOf[6]; enum: ["hasChildren"]
query.search[].op string Required anyOf[6]; enum: ["in"]
query.search[].value array Required anyOf[6]; minItems: 1; maxItems: 100
query.search[].value[] — Optional anyOf[6]
query.search[].value[] boolean Optional anyOf[6]; anyOf[1]
query.search[].value[] string Optional anyOf[6]; anyOf[2]; enum: ["true"]
query.search[].value[] string Optional anyOf[6]; anyOf[3]; enum: ["false"]
query.search[].value[] number Optional anyOf[6]; anyOf[4]; enum: [1]
query.search[].value[] number Optional anyOf[6]; anyOf[5]; enum: [0]
query.search[].value[] string Optional anyOf[6]; anyOf[6]; enum: ["1"]
query.search[].value[] string Optional anyOf[6]; anyOf[7]; enum: ["0"]
query.searchBranches array Optional JSON-encoded. OR branches of structured search filters. Filters within a branch are AND'd, branches are OR'd, and the result is AND'd with search: AND(search) AND OR(AND(branch 1), ...). Max 8 branches of 1-10 conditions each. Not supported for analytics datasets, and indicator filters are not yet supported inside branches. Cursor pages carry the original branches, so do not resend them with cursor. minItems: 1; maxItems: 8
query.searchBranches[] array Optional minItems: 1; maxItems: 10
query.searchBranches[][] — Optional
query.searchBranches[][] object Optional anyOf[1]; additionalProperties: false
query.searchBranches[][].field string Required anyOf[1]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
query.searchBranches[][].op string Required anyOf[1]; enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","find"]
query.searchBranches[][].value string Required anyOf[1]; minLength: 1; maxLength: 512
query.searchBranches[][] object Optional anyOf[2]; additionalProperties: false
query.searchBranches[][].field string Required anyOf[2]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
query.searchBranches[][].op string Required anyOf[2]; enum: ["in"]
query.searchBranches[][].value array Required anyOf[2]; minItems: 1; maxItems: 100
query.searchBranches[][].value[] string Optional anyOf[2]; minLength: 1; maxLength: 512
query.searchBranches[][] object Optional anyOf[3]; additionalProperties: false
query.searchBranches[][].field string Required anyOf[3]; enum: ["killChain"]
query.searchBranches[][].op string Required anyOf[3]; enum: ["equals","not","gt","gte","lt","lte"]
query.searchBranches[][].value — Required anyOf[3]
query.searchBranches[][].value number Required anyOf[3]; anyOf[1]
query.searchBranches[][].value string Required anyOf[3]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
query.searchBranches[][] object Optional anyOf[4]; additionalProperties: false
query.searchBranches[][].field string Required anyOf[4]; enum: ["killChain"]
query.searchBranches[][].op string Required anyOf[4]; enum: ["in"]
query.searchBranches[][].value array Required anyOf[4]; minItems: 1; maxItems: 100
query.searchBranches[][].value[] — Optional anyOf[4]
query.searchBranches[][].value[] number Optional anyOf[4]; anyOf[1]
query.searchBranches[][].value[] string Optional anyOf[4]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
query.searchBranches[][] object Optional anyOf[5]; additionalProperties: false
query.searchBranches[][].field string Required anyOf[5]; enum: ["hasChildren"]
query.searchBranches[][].op string Required anyOf[5]; enum: ["equals","not","gt","gte","lt","lte"]
query.searchBranches[][].value — Required anyOf[5]
query.searchBranches[][].value boolean Required anyOf[5]; anyOf[1]
query.searchBranches[][].value string Required anyOf[5]; anyOf[2]; enum: ["true"]
query.searchBranches[][].value string Required anyOf[5]; anyOf[3]; enum: ["false"]
query.searchBranches[][].value number Required anyOf[5]; anyOf[4]; enum: [1]
query.searchBranches[][].value number Required anyOf[5]; anyOf[5]; enum: [0]
query.searchBranches[][].value string Required anyOf[5]; anyOf[6]; enum: ["1"]
query.searchBranches[][].value string Required anyOf[5]; anyOf[7]; enum: ["0"]
query.searchBranches[][] object Optional anyOf[6]; additionalProperties: false
query.searchBranches[][].field string Required anyOf[6]; enum: ["hasChildren"]
query.searchBranches[][].op string Required anyOf[6]; enum: ["in"]
query.searchBranches[][].value array Required anyOf[6]; minItems: 1; maxItems: 100
query.searchBranches[][].value[] — Optional anyOf[6]
query.searchBranches[][].value[] boolean Optional anyOf[6]; anyOf[1]
query.searchBranches[][].value[] string Optional anyOf[6]; anyOf[2]; enum: ["true"]
query.searchBranches[][].value[] string Optional anyOf[6]; anyOf[3]; enum: ["false"]
query.searchBranches[][].value[] number Optional anyOf[6]; anyOf[4]; enum: [1]
query.searchBranches[][].value[] number Optional anyOf[6]; anyOf[5]; enum: [0]
query.searchBranches[][].value[] string Optional anyOf[6]; anyOf[6]; enum: ["1"]
query.searchBranches[][].value[] string Optional anyOf[6]; anyOf[7]; enum: ["0"]
query.page number Optional Page number (1-indexed) for offset-based pagination. Limited to offset of 100,000 records. For deep pagination, use cursor-based pagination instead.
query.pageSize number Optional Number of results per page. Maximum 25,000.
query.orderBy string Optional
query.order string Optional enum: ["asc","desc"]
query.datasetId array Optional Dataset UUIDs to query, or one standalone scope value: 'all'/'*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). Scope values query at most 50 datasets. If not provided, uses the default dataset.
query.datasetId[] string Optional
query.forceRefresh boolean Optional
query.format string Optional enum: ["json","stix2","taxii"]
query.cache string Optional Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. enum: ["from-graph"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search events — cloudflare.post_eventlist

Lists events, with filters sent in a JSON request body. Accepts the same filters as threat-intel events list and suits long or complex search filters. datasetId accepts dataset UUIDs or one scope value used alone: all (or ) and operational select the intelligence datasets you can read, and analytics selects the analytics datasets you can read. A scope value covers at most 50 datasets. Without datasetId, the default Cloudforce One Threat Events dataset is used.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.forceRefresh boolean Optional
query.format string Optional Output format for event data. 'json' returns the default format, 'stix2' returns STIX 2.1 Sighting SROs with linked Indicator SDOs, Observed Data SDOs, and SCOs, 'taxii' returns a TAXII 2.1 Envelope with Content-Type application/taxii+json;version=2.1. enum: ["json","stix2","taxii"]
query.cache string Optional Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. enum: ["from-graph"]
body object Optional
body.cursor string Optional Cursor for pagination. When provided, filters are embedded in the cursor so you only need to pass cursor and pageSize.
body.datasetId array Optional Dataset UUIDs to query, or one standalone scope value: 'all'/'*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). Scope values query at most 50 datasets. If not provided, uses the default dataset.
body.datasetId[] string Optional
body.order string Optional enum: ["asc","desc"]
body.orderBy string Optional
body.page number Optional
body.pageSize number Optional
body.search array Optional Structured search as a JSON array of {field, op, value} objects. Use the 'in' operator with an array value to bulk-check up to 100 values. Multiple conditions are AND'd together. Max 10 conditions per request. default: []; maxItems: 10
body.search[] — Optional
body.search[] object Optional anyOf[1]; additionalProperties: false
body.search[].field string Required anyOf[1]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.search[].op string Required anyOf[1]; enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","find"]
body.search[].value string Required anyOf[1]; minLength: 1; maxLength: 512
body.search[] object Optional anyOf[2]; additionalProperties: false
body.search[].field string Required anyOf[2]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.search[].op string Required anyOf[2]; enum: ["in"]
body.search[].value array Required anyOf[2]; minItems: 1; maxItems: 100
body.search[].value[] string Optional anyOf[2]; minLength: 1; maxLength: 512
body.search[] object Optional anyOf[3]; additionalProperties: false
body.search[].field string Required anyOf[3]; enum: ["killChain"]
body.search[].op string Required anyOf[3]; enum: ["equals","not","gt","gte","lt","lte"]
body.search[].value — Required anyOf[3]
body.search[].value number Required anyOf[3]; anyOf[1]
body.search[].value string Required anyOf[3]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.search[] object Optional anyOf[4]; additionalProperties: false
body.search[].field string Required anyOf[4]; enum: ["killChain"]
body.search[].op string Required anyOf[4]; enum: ["in"]
body.search[].value array Required anyOf[4]; minItems: 1; maxItems: 100
body.search[].value[] — Optional anyOf[4]
body.search[].value[] number Optional anyOf[4]; anyOf[1]
body.search[].value[] string Optional anyOf[4]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.search[] object Optional anyOf[5]; additionalProperties: false
body.search[].field string Required anyOf[5]; enum: ["hasChildren"]
body.search[].op string Required anyOf[5]; enum: ["equals","not","gt","gte","lt","lte"]
body.search[].value — Required anyOf[5]
body.search[].value boolean Required anyOf[5]; anyOf[1]
body.search[].value string Required anyOf[5]; anyOf[2]; enum: ["true"]
body.search[].value string Required anyOf[5]; anyOf[3]; enum: ["false"]
body.search[].value number Required anyOf[5]; anyOf[4]; enum: [1]
body.search[].value number Required anyOf[5]; anyOf[5]; enum: [0]
body.search[].value string Required anyOf[5]; anyOf[6]; enum: ["1"]
body.search[].value string Required anyOf[5]; anyOf[7]; enum: ["0"]
body.search[] object Optional anyOf[6]; additionalProperties: false
body.search[].field string Required anyOf[6]; enum: ["hasChildren"]
body.search[].op string Required anyOf[6]; enum: ["in"]
body.search[].value array Required anyOf[6]; minItems: 1; maxItems: 100
body.search[].value[] — Optional anyOf[6]
body.search[].value[] boolean Optional anyOf[6]; anyOf[1]
body.search[].value[] string Optional anyOf[6]; anyOf[2]; enum: ["true"]
body.search[].value[] string Optional anyOf[6]; anyOf[3]; enum: ["false"]
body.search[].value[] number Optional anyOf[6]; anyOf[4]; enum: [1]
body.search[].value[] number Optional anyOf[6]; anyOf[5]; enum: [0]
body.search[].value[] string Optional anyOf[6]; anyOf[6]; enum: ["1"]
body.search[].value[] string Optional anyOf[6]; anyOf[7]; enum: ["0"]
body.searchBranches array Optional OR branches of structured search filters. Filters within a branch are AND'd, branches are OR'd, and the result is AND'd with search: AND(search) AND OR(AND(branch 1), ...). Max 8 branches of 1-10 conditions each. Not supported for analytics datasets, and indicator filters are not yet supported inside branches. Cursor pages carry the original branches, so do not resend them with cursor. minItems: 1; maxItems: 8
body.searchBranches[] array Optional minItems: 1; maxItems: 10
body.searchBranches[][] — Optional
body.searchBranches[][] object Optional anyOf[1]; additionalProperties: false
body.searchBranches[][].field string Required anyOf[1]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.searchBranches[][].op string Required anyOf[1]; enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","find"]
body.searchBranches[][].value string Required anyOf[1]; minLength: 1; maxLength: 512
body.searchBranches[][] object Optional anyOf[2]; additionalProperties: false
body.searchBranches[][].field string Required anyOf[2]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.searchBranches[][].op string Required anyOf[2]; enum: ["in"]
body.searchBranches[][].value array Required anyOf[2]; minItems: 1; maxItems: 100
body.searchBranches[][].value[] string Optional anyOf[2]; minLength: 1; maxLength: 512
body.searchBranches[][] object Optional anyOf[3]; additionalProperties: false
body.searchBranches[][].field string Required anyOf[3]; enum: ["killChain"]
body.searchBranches[][].op string Required anyOf[3]; enum: ["equals","not","gt","gte","lt","lte"]
body.searchBranches[][].value — Required anyOf[3]
body.searchBranches[][].value number Required anyOf[3]; anyOf[1]
body.searchBranches[][].value string Required anyOf[3]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.searchBranches[][] object Optional anyOf[4]; additionalProperties: false
body.searchBranches[][].field string Required anyOf[4]; enum: ["killChain"]
body.searchBranches[][].op string Required anyOf[4]; enum: ["in"]
body.searchBranches[][].value array Required anyOf[4]; minItems: 1; maxItems: 100
body.searchBranches[][].value[] — Optional anyOf[4]
body.searchBranches[][].value[] number Optional anyOf[4]; anyOf[1]
body.searchBranches[][].value[] string Optional anyOf[4]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.searchBranches[][] object Optional anyOf[5]; additionalProperties: false
body.searchBranches[][].field string Required anyOf[5]; enum: ["hasChildren"]
body.searchBranches[][].op string Required anyOf[5]; enum: ["equals","not","gt","gte","lt","lte"]
body.searchBranches[][].value — Required anyOf[5]
body.searchBranches[][].value boolean Required anyOf[5]; anyOf[1]
body.searchBranches[][].value string Required anyOf[5]; anyOf[2]; enum: ["true"]
body.searchBranches[][].value string Required anyOf[5]; anyOf[3]; enum: ["false"]
body.searchBranches[][].value number Required anyOf[5]; anyOf[4]; enum: [1]
body.searchBranches[][].value number Required anyOf[5]; anyOf[5]; enum: [0]
body.searchBranches[][].value string Required anyOf[5]; anyOf[6]; enum: ["1"]
body.searchBranches[][].value string Required anyOf[5]; anyOf[7]; enum: ["0"]
body.searchBranches[][] object Optional anyOf[6]; additionalProperties: false
body.searchBranches[][].field string Required anyOf[6]; enum: ["hasChildren"]
body.searchBranches[][].op string Required anyOf[6]; enum: ["in"]
body.searchBranches[][].value array Required anyOf[6]; minItems: 1; maxItems: 100
body.searchBranches[][].value[] — Optional anyOf[6]
body.searchBranches[][].value[] boolean Optional anyOf[6]; anyOf[1]
body.searchBranches[][].value[] string Optional anyOf[6]; anyOf[2]; enum: ["true"]
body.searchBranches[][].value[] string Optional anyOf[6]; anyOf[3]; enum: ["false"]
body.searchBranches[][].value[] number Optional anyOf[6]; anyOf[4]; enum: [1]
body.searchBranches[][].value[] number Optional anyOf[6]; anyOf[5]; enum: [0]
body.searchBranches[][].value[] string Optional anyOf[6]; anyOf[6]; enum: ["1"]
body.searchBranches[][].value[] string Optional anyOf[6]; anyOf[7]; enum: ["0"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Aggregate events — cloudflare.get_eventaggregate

Counts events grouped by one or more columns, such as attacker or targetIndustry. Optionally filter by date range and group the counts by day.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Required additionalProperties: false
query.aggregateBy string Required Column(s) to aggregate by - single column or comma-separated list (e.g., 'attacker', 'targetIndustry', 'attacker,targetIndustry'). With tags, an event counts once for each of its tags, in the bucket counts and in total, and events without tags count as Unknown; tags is not supported for analytics datasets.
query.datasetId array Optional Dataset UUIDs to filter by, or one standalone scope value: 'all'/'*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). Scope values query at most 50 datasets. If not provided, uses the default dataset.
query.datasetId[] string Optional
query.startDate string Optional Start date for filtering (ISO 8601 format, e.g., '2024-01-01')
query.endDate string Optional End date for filtering (ISO 8601 format, e.g., '2024-12-31')
query.groupByDate boolean Optional Whether to group results by date (daily aggregation)
query.limit number Optional Maximum number of results to return default: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "aggregateBy": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List attackers — cloudflare.get_attackerlist

Lists the attackers referenced by events in the datasets given by datasetIds, or in the default dataset when datasetIds is omitted.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.datasetIds array Optional Array of dataset IDs to query attackers from. If not provided, uses the default dataset.
query.datasetIds[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List related events — cloudflare.get_eventrelationships

Lists events related to an event by following its relationships. datasetId is required. Use direction, maxDepth, and relationshipTypes to control which relationships are followed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
query object Required additionalProperties: false
query.direction string Optional The direction to traverse the graph. Defaults to 'both' to search all. enum: ["ancestors","descendants","both"]; default: "both"
query.maxDepth number Optional The maximum depth to traverse. Defaults to 5.
query.relationshipTypes — Optional An optional array of relationship types to filter by.
query.relationshipTypes string Optional anyOf[1]
query.relationshipTypes array Optional anyOf[2]
query.relationshipTypes[] string Optional anyOf[2]
query.indicatorTypeIds array Optional An optional array of indicator type IDs to filter the results by.
query.indicatorTypeIds[] string Optional
query.datasetId string Required The dataset ID to search within.
query.includeParent boolean Optional Whether to include the starting event in the results. Defaults to true. default: true
query.page number Optional
query.pageSize number Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example"
  },
  "query": {
    "datasetId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List event categories used in datasets — cloudflare.get_categorylist

Lists the event categories used by events in the datasets given by datasetIds, or in the default dataset when datasetIds is omitted. Dataset scope values are not supported. To list every category, use threat-intel events categories catalog list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.datasetIds array Optional Array of dataset IDs to query categories from. If not provided, uses the default dataset.
query.datasetIds[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all event categories — cloudflare.get_categorylistcomplete

Lists every event category in the catalog, whether or not an event uses it. To list only the categories used in specific datasets, use threat-intel events categories list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an event category — cloudflare.post_categorycreate

Creates an event category for classifying events. name and killChain are required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.killChain number Required
body.mitreAttack array Optional
body.mitreAttack[] string Optional
body.mitreCapec array Optional
body.mitreCapec[] string Optional
body.name string Required
body.shortname string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List countries — cloudflare.get_countryread

Lists the countries used in threat intelligence data, such as attacker and target countries.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an event — cloudflare.post_eventcreate

Creates an event. Without datasetId, the event is created in the default Cloudforce One Threat Events dataset. To create a dataset, use threat-intel datasets create.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.accountId number Optional
body.attacker string | null Optional
body.attackerCountry string Optional
body.category string Required
body.datasetId string Optional
body.date string Required format: "date-time"
body.event string Required
body.indicator string Optional
body.indicatorType string Optional
body.indicators array Optional Array of indicators for this event. Supports multiple indicators per event for complex scenarios.
body.indicators[] object Optional
body.indicators[].indicatorType string Required The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
body.indicators[].value string Required The indicator value (e.g., domain name, IP address, hash)
body.insight string Optional
body.raw object Required
body.raw.data object | null Required additionalProperties: true
body.raw.source string Optional
body.raw.tlp string Optional
body.source object Optional Controlled provenance for an event and its indicators derived from a Threat Signals article. additionalProperties: false
body.source.resourceId string Required format: "uuid"
body.source.resourceType string Required enum: ["article"]
body.source.system string Required enum: ["threat-signals"]
body.source.title string | null Optional Threat Signals article title; null for historical provenance without a stored title.
body.tags array Optional
body.tags[] string Optional
body.targetCountry string Optional
body.targetIndustry string Optional
body.tlp string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create events in bulk — cloudflare.post_eventcreatebulk

Creates multiple events in one dataset. datasetId is required; to find dataset IDs, use threat-intel datasets list. Set includeCreatedEvents to return the UUIDs of the created events.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.data array Required
body.data[] object Optional
body.data[].accountId number Optional
body.data[].attacker string | null Optional
body.data[].attackerCountry string Optional
body.data[].category string Required
body.data[].datasetId string Optional
body.data[].date string Required format: "date-time"
body.data[].event string Required
body.data[].indicator string Optional
body.data[].indicatorType string Optional
body.data[].indicators array Optional Array of indicators for this event. Supports multiple indicators per event for complex scenarios.
body.data[].indicators[] object Optional
body.data[].indicators[].indicatorType string Required The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
body.data[].indicators[].value string Required The indicator value (e.g., domain name, IP address, hash)
body.data[].insight string Optional
body.data[].raw object Required
body.data[].raw.data object | null Required additionalProperties: true
body.data[].raw.source string Optional
body.data[].raw.tlp string Optional
body.data[].tags array Optional
body.data[].tags[] string Optional
body.data[].targetCountry string Optional
body.data[].targetIndustry string Optional
body.data[].tlp string Required
body.datasetId string Required
body.includeCreatedEvents boolean Optional When true, response includes array of created event UUIDs and shard IDs. Useful for tracking which events were created and where.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List datasets — cloudflare.get_datasetlist

Lists the account's datasets. Set includeDeleted to include deleted datasets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.includeDeleted boolean Optional When true, include soft-deleted datasets in the response. Each item includes a deletedAt field (ISO 8601 or null). Default: false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account groups — cloudflare.get_grouplist

Lists the account groups. A group is a set of accounts that can be given access to a dataset with threat-intel datasets access permissions create.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an account group — cloudflare.post_groupcreate

Creates a named group of accounts. To give the group access to a dataset, use threat-intel datasets access permissions create.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.description string Required
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an account group — cloudflare.delete_groupdelete

Deletes an account group by its ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.group_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an account group — cloudflare.get_groupread

Returns an account group by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.group_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an account group — cloudflare.put_groupupdate

Replaces an account group's name and description.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.group_id string Required
body object Optional
body.description string Required
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List group members — cloudflare.get_groupmemberlist

Lists the accounts in an account group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.group_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an account to a group — cloudflare.post_groupmembercreate

Adds an account to an account group. Identify the account by accountId or accountTag.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.group_id string Required
body object Optional
body.accountId string Optional
body.accountTag string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an account from a group — cloudflare.delete_groupmemberdelete

Removes an account from an account group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.group_id string Required
path.member_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "12345678-1234-1234-1234-1234567890ab",
    "member_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a dataset — cloudflare.post_datasetcreate

Creates a dataset for grouping events. Set isPublic to true to let anyone search it; otherwise only the account can.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.isPublic boolean Required If true, then anyone can search the dataset. If false, then its limited to the account.
body.name string Required Used to describe the dataset within the account context. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a dataset — cloudflare.delete_datasetdelete

Deletes a dataset. To see deleted datasets, use threat-intel datasets list with includeDeleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID to delete

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a dataset — cloudflare.get_datasetread

Returns a dataset by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a dataset — cloudflare.patch_datasetupdate

Updates a dataset's name and isPublic setting. Both fields are required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID. format: "uuid"
body object Optional
body.isPublic boolean Required If true, then anyone can search the dataset. If false, then its limited to the account.
body.name string Required Used to describe the dataset within the account context. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a dataset — cloudflare.post_datasetupdate

Updates a dataset's name and isPublic setting. Both fields are required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID. format: "uuid"
body object Optional
body.isPublic boolean Required If true, then anyone can search the dataset. If false, then its limited to the account.
body.name string Required Used to describe the dataset within the account context. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Copy events to another dataset — cloudflare.post_eventcopytonewds

Copies events to the dataset given by destDatasetId and leaves the originals in place. Raw event data is copied only when keepRawData is true.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
query object Optional additionalProperties: false
query.keepRawData boolean Optional If true, copies raw data to the destination dataset. Default is false (raw data is stripped/not copied).
body object Optional
body.destDatasetId string Required
body.eventIds array Required
body.eventIds[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an event — cloudflare.get_eventread

Returns an event from a dataset by its UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID.
path.event_id string Required Event UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example",
    "event_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an indicator type — cloudflare.post_indicatortypecreate

Creates an indicator type in a dataset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID.
body object Optional
body.description string Optional Optional description for the indicator type
body.indicatorType string Required The indicator type to create (e.g., 'DOMAIN', 'IP', 'URL', 'HASH', 'EMAIL') minLength: 1; maxLength: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete indicators in bulk — cloudflare.delete_indicatordeletebulk

Deletes up to 200 indicators from a dataset. Pass the indicator UUIDs in indicatorIds; UUIDs that are not found are returned in missingUUIDs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID.
query object Required additionalProperties: false
query.indicatorIds array Required Indicator UUIDs to delete, 1-200 per request. minItems: 1; maxItems: 200
query.indicatorIds[] string Optional format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example"
  },
  "query": {
    "indicatorIds": [
      "00000000-0000-4000-8000-000000000000"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create indicators in bulk — cloudflare.post_indicatorcreatebulk

Creates multiple indicators in a dataset in one request. Set autoCreateType to create any indicator types that don't exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
body object Optional
body.autoCreateType boolean Optional Global flag to automatically create indicator types if they don't exist. Individual indicators can override this with their own autoCreateType flag.
body.indicators array Required
body.indicators[] object Optional
body.indicators[].autoCreateType boolean Optional If true, automatically create the indicator type if it doesn't exist. If false (default), throw an error when the indicator type doesn't exist.
body.indicators[].indicatorType string Required
body.indicators[].relatedEvents array Optional
body.indicators[].relatedEvents[] object Optional
body.indicators[].relatedEvents[].datasetId string Required
body.indicators[].relatedEvents[].eventId string Required
body.indicators[].tags array Optional
body.indicators[].tags[] — Optional
body.indicators[].tags[] string Optional anyOf[1]
body.indicators[].tags[] object Optional anyOf[2]
body.indicators[].tags[].categoryName string Optional anyOf[2]
body.indicators[].tags[].value string Required anyOf[2]
body.indicators[].tlp string Optional Traffic Light Protocol designation. Case-insensitive on input, stored and returned as UPPERCASE. Allowed values: clear, green, amber, amber-strict, red, purple.
body.indicators[].value string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an indicator — cloudflare.post_indicatorcreate

Creates an indicator in a dataset. Set autoCreateType to create the indicator type if it doesn't exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
body object Optional
body.autoCreateType boolean Optional If true, automatically create the indicator type if it doesn't exist. If false (default), throw an error when the indicator type doesn't exist.
body.indicatorType string Required
body.relatedEvents array Optional
body.relatedEvents[] object Optional
body.relatedEvents[].datasetId string Required
body.relatedEvents[].eventId string Required
body.tags array Optional
body.tags[] — Optional
body.tags[] string Optional anyOf[1]
body.tags[] object Optional anyOf[2]
body.tags[].categoryName string Optional anyOf[2]
body.tags[].value string Required anyOf[2]
body.tlp string Optional Traffic Light Protocol designation. Case-insensitive on input, stored and returned as UPPERCASE. Allowed values: clear, green, amber, amber-strict, red, purple.
body.value string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tags on a dataset's indicators — cloudflare.get_indicatortagslist

Lists the tags applied to indicators in a dataset. Results are not paginated.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an indicator — cloudflare.delete_indicatordelete

Deletes an indicator by its UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID.
path.indicator_id string Required Indicator UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example",
    "indicator_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an indicator — cloudflare.get_indicatorread

Returns an indicator by its UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID.
path.indicator_id string Required Indicator UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example",
    "indicator_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an indicator — cloudflare.patch_indicatorupdate

Updates the given fields of an indicator and leaves the other fields unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset ID.
path.indicator_id string Required Indicator UUID.
body object Optional
body.indicatorType string Optional
body.relatedEvents array Optional
body.relatedEvents[] object Optional
body.relatedEvents[].datasetId string Required
body.relatedEvents[].eventId string Required
body.tags array Optional
body.tags[] — Optional
body.tags[] string Optional anyOf[1]
body.tags[] object Optional anyOf[2]
body.tags[].categoryName string Optional anyOf[2]
body.tags[].value string Required anyOf[2]
body.tlp string Optional Traffic Light Protocol designation. Case-insensitive on input, stored and returned as UPPERCASE. Allowed values: clear, green, amber, amber-strict, red, purple.
body.value string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "example",
    "indicator_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List indicator relationships — cloudflare.get_indicatorrelationshipslist

Lists the relationships that start at an indicator. Use search to filter them and expand to include the related entities in the response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
path.indicator_id string Required Indicator UUID.
query object Optional additionalProperties: false
query.search array Optional JSON array of {field, op, value} filters, AND-combined. Fields: entityType (other-end type), type (relationship type), confidence (0–100), metadata.<key>. Example: [{"field":"type","op":"equals","value":"appears_in"},{"field":"confidence","op":"gte","value":50}]
query.search[] object Optional
query.search[].field string Required entityType | type | confidence | metadata.<key>
query.search[].op string Required Search operator. 'exists' only valid for metadata.<key> fields. enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find","exists"]
query.search[].value — Optional Value to compare against. Omit for 'exists' op.
query.search[].value string Optional anyOf[1]
query.search[].value number Optional anyOf[2]
query.search[].value boolean Optional anyOf[3]
query.search[].value array Optional anyOf[4]
query.search[].value[] — Optional anyOf[4]
query.search[].value[] string Optional anyOf[4]; anyOf[1]
query.search[].value[] number Optional anyOf[4]; anyOf[2]
query.expand array Optional Comma-separated entity types to hydrate (event, indicator, tag).
query.expand[] string Optional
query.cursor string Optional Keyset cursor from a previous page.
query.pageSize integer Optional Page size (1–100, default 25). default: 25; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000",
    "indicator_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an indicator relationship — cloudflare.post_indicatorrelationshipcreate

Creates a relationship from an indicator to an event or tag (targetType). Relationships between two indicators are not supported.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
path.indicator_id string Required Indicator UUID.
body object Optional
body.confidence integer Optional Confidence score 0–100. minimum: 0; maximum: 100
body.metadata object Optional Arbitrary JSON metadata. additionalProperties: true
body.targetId string Required UUID of the target entity. minLength: 1
body.targetType string Required Target type. "indicator" is not allowed (indicator↔indicator relationships are not supported). enum: ["event","tag"]
body.type string Required Relationship type. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000",
    "indicator_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an indicator relationship — cloudflare.delete_indicatorrelationshipdelete

Deletes an indicator relationship by its UUID. Returns deleted: false if the relationship doesn't exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
path.indicator_id string Required Indicator UUID.
path.rel_uuid string Required Relationship UUID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000",
    "indicator_id": "example",
    "rel_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an indicator relationship — cloudflare.patch_indicatorrelationshipupdate

Updates the given fields of an indicator relationship and leaves the other fields unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
path.indicator_id string Required Indicator UUID.
path.rel_uuid string Required Relationship UUID. format: "uuid"
body object Optional
body.confidence integer | null Optional Updated confidence. null clears it. minimum: 0; maximum: 100
body.metadata object | null Optional Updated metadata. null clears it. additionalProperties: true
body.type string Optional Updated relationship type. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000",
    "indicator_id": "example",
    "rel_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Move events to another dataset — cloudflare.post_eventmovetonewds

Moves events to the dataset given by destDatasetId and removes them from the source dataset. Raw event data is always removed from the source and is kept only when keepRawData is true.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
query object Optional additionalProperties: false
query.keepRawData boolean Optional If true, copies raw data to the destination dataset. Default is false (raw data is stripped/not copied). Raw data is always deleted from the source.
body object Optional
body.destDatasetId string Required
body.eventIds array Required
body.eventIds[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List dataset permissions — cloudflare.get_permissionlist

Lists the access grants on a dataset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Grant access to a dataset — cloudflare.post_permissioncreate

Gives an account or account group (subjectType and subjectId) read or write access to a dataset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
body object Optional
body.role string Required enum: ["read","write"]
body.subjectId string Required
body.subjectType string Required enum: ["account","group"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke access to a dataset — cloudflare.delete_permissiondelete

Removes an access grant from a dataset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
path.grant_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000",
    "grant_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change a dataset permission — cloudflare.put_permissionupdate

Changes the role of an access grant to read or write.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
path.grant_id string Required
body object Optional
body.role string Required enum: ["read","write"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000",
    "grant_id": "12345678-1234-1234-1234-1234567890ab"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List target industries in a dataset (legacy) — cloudflare.get_targetindustrylistbydataset

Legacy. Use threat-intel events target-industries list (GET /events/targetIndustries) instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rebuild dataset lookup lists — cloudflare.post_datasetpopulate

Rebuilds the lists of attackers, categories, indicator types, and target industries for the account's datasets from their existing events. Datasets are processed in batches.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete events — cloudflare.delete_eventdelete

Deletes one or more events from a dataset. Pass the event UUIDs in eventIds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.dataset_id string Required Dataset UUID. format: "uuid"
query object Required additionalProperties: false
query.eventIds array Required Array of Event IDs to delete.
query.eventIds[] string Optional minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  },
  "query": {
    "eventIds": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get raw data for an event — cloudflare.get_eventrawreadds

Returns the raw source data stored with an event.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event ID.
path.dataset_id string Required Dataset ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example",
    "dataset_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an event category — cloudflare.delete_categorydelete

Deletes an event category by its ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.category_id string Required Category UUID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an event category — cloudflare.get_categoryread

Returns an event category by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.category_id string Required Category UUID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an event category — cloudflare.patch_categoryupdate

Updates the given fields of an event category and leaves the other fields unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.category_id string Required Category UUID. format: "uuid"
body object Optional
body.killChain number Optional
body.mitreAttack array Optional
body.mitreAttack[] string Optional
body.mitreCapec array Optional
body.mitreCapec[] string Optional
body.name string Optional
body.shortname string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an event category — cloudflare.post_categoryupdate

Updates the given fields of an event category and leaves the other fields unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.category_id string Required Category UUID. format: "uuid"
body object Optional
body.killChain number Optional
body.mitreAttack array Optional
body.mitreAttack[] string Optional
body.mitreCapec array Optional
body.mitreCapec[] string Optional
body.name string Optional
body.shortname string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove tags from an event (legacy) — cloudflare.delete_eventtagdelete

Legacy. Use threat-intel tags relationships delete (DELETE /events/tags/{tag_uuid}/relationships/{rel_uuid}) instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
body object Optional
body.tags array Required
body.tags[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add tags to an event (legacy) — cloudflare.post_eventtagcreate

Legacy. Use threat-intel tags relationships create (POST /events/tags/{tag_uuid}/relationships) instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
body object Optional
body.tags array Required
body.tags[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query graph neighborhood from R2 Data Catalog — cloudflare.get_eventgraph

Expands the single-level relationship neighborhood of one or more seed nodes (event, indicator, or tag) from R2 Data Catalog. Seeds use compact id format (type:uuid), e.g. "event:550e8400-...". Multi-seed requests merge and deduplicate results server-side. Hydrates neighbor entities with summary data from Durable Objects. Supports filtering by relationship type and dataset scope.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.seeds array Optional Comma-separated compact seed ids (type:uuid). Example: seeds=event:550e8400-...,indicator:661fa920-... Provide 1–50 entries; omitting seeds returns 400.
query.seeds[] string Optional
query.direction string Optional Edge direction relative to each seed: out (seed→neighbors), in (neighbors→seed), both (default).
query.hydration string Optional Hydration strategy for neighbor nodes when expand=nodes is set. r2_join (default): use R2 JOIN query + DO fallback. do_only: use plain R2 query + hydrate all neighbors via Durable Objects.
query.limit number Optional Max neighbors per seed (default: 100, max: 1000). Values above 1000 return 400.
query.max_nodes number Optional Total accumulated node cap across all seeds (default: 500, max: 1000). Values above 1000 return 400.
query.relationshipTypes array Optional Comma-separated relationship types to filter by. Allowed: tagged_with, appears_in, related_to, caused_by, attributed_to.
query.relationshipTypes[] string Optional
query.datasetIds array Optional Comma-separated dataset UUIDs to restrict neighbor scope, or one standalone scope value: 'operational' for readable intelligence datasets (isAnalytics=false), 'analytics' for readable analytics datasets (isAnalytics=true), or 'all'/'*' for every readable dataset including analytics datasets (the graph reads analytics relationships from R2). Intersected with access grants.
query.datasetIds[] string Optional
query.cursor string Optional Opaque pagination token. Only valid when seeds has exactly 1 entry; 400 otherwise.
query.expand array Optional Comma-separated list of response sections to expand (hydrate). Allowed: nodes. Omitting expand returns identifier-only nodes.
query.expand[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run a GraphQL aggregation over events — cloudflare.post_eventgraphql

Runs a GraphQL aggregation query over events. Supports grouping by multiple fields, date range filters, and aggregation across datasets.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List indicator types — cloudflare.get_indicatortypeslist

Lists the indicator types used in the datasets given by datasetIds, which accepts dataset UUIDs or one scope value used alone. Without datasetIds, every dataset you can read is included, analytics datasets too.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.datasetIds array Optional Dataset UUIDs to query, or one standalone scope value: 'operational' for readable intelligence datasets (isAnalytics=false), 'analytics' for readable analytics datasets (isAnalytics=true), or 'all'/'*' for every readable dataset including analytics datasets. If not provided, queries all accessible datasets, including analytics datasets.
query.datasetIds[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List indicators — cloudflare.get_indicatorlist

Lists indicators across datasets, newest first. datasetIds accepts dataset UUIDs or one scope value used alone: all (or ) and operational select the intelligence datasets you can read, and analytics selects the analytics datasets you can read. Without datasetIds, the default dataset is used.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.datasetIds array Optional Dataset UUIDs to query, or one standalone scope value: 'all'/'*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). If not provided, uses the default dataset.
query.datasetIds[] string Optional
query.page number Optional
query.pageSize number Optional
query.search array Optional Structured search as a JSON array of {field, op, value} objects. Searchable fields: value, indicatorType, uuid. Supports operators: equals, not, contains, startsWith, endsWith, gt, lt, gte, lte, like, in, find. Use the 'in' operator with an array value to bulk-check up to 100 indicators in a single request, e.g. search=[{"field":"value","op":"in","value":["evil.com","bad.org"]}]. Multiple conditions are AND'd together. Max 10 conditions per request.
query.search[] object Optional
query.search[].field string Required The indicator field to search on. Allowed: value, indicatorType, uuid. enum: ["value","indicatorType","uuid"]
query.search[].op string Required Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}. enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find"]
query.search[].value — Required Search value. String for most operators. Array of strings for 'in' operator (max 100 items).
query.search[].value string Required anyOf[1]
query.search[].value array Required anyOf[2]
query.search[].value[] string Optional anyOf[2]
query.name string Optional Filter indicators by value using substring match (LIKE). Legacy alternative to structured search.
query.indicatorType string Optional
query.relatedEvents array Optional Filter by related event IDs
query.relatedEvents[] string Optional
query.tags array Optional Filter by tag values or UUIDs. Indicators must have at least one of the specified tags (OR logic). Supports both tag UUID and tag value.
query.tags[] string Optional
query.tagSearch array Optional Structured tag-metadata filter as a JSON array of {field, op, value} objects. Operates against the per-dataset IndicatorTag mirror so you can find indicators by tag attributes (origin country, motive, sophistication, priority, etc.) without a separate Tags lookup. Common dashboard usage: drill from a country into indicators, e.g. tagSearch=[{"field":"originCountryISO","op":"in","value":["IR","CN"]}]. Country values may be passed as alpha-2, alpha-3, name, or alias (e.g. "iran"). Operators: equals, not, gt/gte/lt/lte (numeric only), contains/like/find/startsWith/endsWith (string only), in. AND-joined across entries; combined with tags, a matching tag must satisfy both. Max 10 entries per request, max 100 values per 'in'. Performance notes: originCountryISO uses its B-tree index for equals/not/in. priority uses its B-tree index for numeric comparisons. Other string columns (actorCategory, motive, etc.) are case-insensitive and unindexed; current catalog size makes this a non-issue. endsWith and aliasGroupNames contains/like are leading-wildcard scans and slow on large result sets. aliasGroupNames matches on the JSON-encoded text, so substrings can cross alias boundaries ("apt28" also matches "apt280" when both appear in the same tag's alias list).
query.tagSearch[] object Optional
query.tagSearch[].field string Required Tag mirror field to filter on. Allowed: value, categoryId, actorCategory, aliasGroupNames, attributionConfidence, attributionOrganization, motive, opsecLevel, originCountryISO, sophisticationLevel, priority, analyticPriority. Filters operate against the per-dataset IndicatorTag mirror (which is kept in sync with the Tags SoT by the tag-propagation workflow). enum: ["value","categoryId","actorCategory","aliasGroupNames","attributionConfidence","attributionOrganization","motive","opsecLevel","originCountryISO","sophisticationLevel","priority","analyticPriority"]
query.tagSearch[].op string Required Search operator. Use 'in' for bulk OR within a single field, e.g. {field:"originCountryISO", op:"in", value:["IR","CN"]}. enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find"]
query.tagSearch[].value — Optional Search value. String or number for most operators. Array for 'in' (max 100 items). Country values may be passed as alpha-2, alpha-3, name, or common alias (e.g. "iran", "IR", "IRN") and are normalized to alpha-2 server-side.
query.tagSearch[].value string Optional anyOf[1]
query.tagSearch[].value number Optional anyOf[2]
query.tagSearch[].value array Optional anyOf[3]
query.tagSearch[].value[] — Optional anyOf[3]
query.tagSearch[].value[] string Optional anyOf[3]; anyOf[1]
query.tagSearch[].value[] number Optional anyOf[3]; anyOf[2]
query.createdAfter string Optional Filter indicators created on or after this date. Must use ISO 8601 format (e.g., '2024-01-15T00:00:00Z'). format: "date-time"
query.createdBefore string Optional Filter indicators created on or before this date. Must use ISO 8601 format (e.g., '2024-12-31T23:59:59Z'). format: "date-time"
query.relatedEventsLimit number Optional Limit the number of related events returned per indicator. Default: 2. Set to 0 for none, -1 for all events. For JSON responses, when the limit hides events, the indicator carries relatedEventsHasMore: true and the response includes an advisory message — the cap is never applied silently. STIX and TAXII representations do not include related-event data.
query.includeTags boolean Optional Whether to include full tag details for each indicator. Defaults to true.
query.includeTotalCount boolean Optional Whether to compute total count via COUNT(*). Defaults to false for performance. total_count is null unless this is true and the complete fan-out succeeds.
query.format string Optional Output format for indicator data. 'json' returns the default format, 'stix2' returns STIX 2.1 Indicator SDOs, 'taxii' returns a TAXII 2.1 Envelope with Content-Type application/taxii+json;version=2.1. enum: ["json","stix2","taxii"]
query.cache string Optional Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. Cannot be combined with cursor. enum: ["from-graph"]
query.cursor string Optional Opaque cursor from a previous response's pagination.cursor. When provided, all filters, datasetIds, page, pageSize, includeTags and relatedEventsLimit come from the cursor — do not resend them. Sending any filter, page, pageSize, includeTags, relatedEventsLimit, includeTotalCount=true, or cache=from-graph alongside a cursor yields a 400 CursorFilterConflictError. A cursor issued for a different entity, an unsupported version, or a dataset that has since been reconfigured as analytics-only yields a 400 InvalidCursorError.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Aggregate indicators by column(s) — cloudflare.get_indicatoraggregate

Aggregate threat indicators by one or more columns (e.g., indicatorType, value) across datasets. Returns top-N groups ordered by count.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Required additionalProperties: false
query.aggregateBy string Required Column(s) to aggregate by - single column or comma-separated list (e.g., 'indicatorType', 'value', 'indicatorType,value')
query.measure string Optional What to count per group: 'indicators' (catalog rows, default) or 'relationships' (linked events per indicator). Use 'relationships' for 'top indicator by event activity'. enum: ["indicators","relationships"]; default: "indicators"
query.tagUuid string Optional Scope to indicators associated with this tag/actor UUID. Combine with measure=relationships for 'top indicator for an actor'.
query.datasetIds array Optional Dataset UUIDs to filter by, or one standalone scope value: 'operational' for readable intelligence datasets (isAnalytics=false), 'analytics' for readable analytics datasets (isAnalytics=true), or 'all'/'*' for every readable dataset including analytics datasets. If not provided, aggregates across all accessible datasets, including analytics datasets.
query.datasetIds[] string Optional
query.createdAfter — Optional Filter indicators created after this date/datetime (ISO 8601, e.g., '2024-01-01' or '2024-01-01T00:00:00Z')
query.createdAfter string Optional anyOf[1]; format: "date-time"
query.createdAfter string Optional anyOf[2]; pattern: "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
query.createdBefore — Optional Filter indicators created before this date/datetime (ISO 8601, e.g., '2024-12-31' or '2024-12-31T23:59:59Z')
query.createdBefore string Optional anyOf[1]; format: "date-time"
query.createdBefore string Optional anyOf[2]; pattern: "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
query.eventDateAfter string Optional For measure=relationships: only count indicator→event links whose relationship was created/observed on or after this date (ISO 8601). Bounds the activity view to recently-observed links. Note: this filters by the relationship's createdAt (link-observation time), not the underlying event's business date.
query.eventDateBefore string Optional For measure=relationships: only count indicator→event links whose relationship was created/observed on or before this date (ISO 8601). Bounds the activity view by the relationship's createdAt (link-observation time), not the underlying event's business date.
query.limit number Optional Maximum number of aggregation results to return (1-100) default: 10; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "aggregateBy": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List saved event queries — cloudflare.get_eventquerylist

Lists the account's saved event queries.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a saved event query — cloudflare.post_eventquerycreate

Saves an event query under a unique name. query_json holds the query parameters as a JSON string.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.alert_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed. default: false
body.alert_rollup_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed. default: false
body.name string Required Unique name for the saved query
body.query_json string Required JSON string containing the query parameters
body.rule_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed. default: false
body.rule_scope string Optional Deprecated and ignored: saved-query alerting and rules were removed.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a saved event query — cloudflare.delete_eventquerydelete

Deletes a saved event query by its ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.query_id integer Required Event query ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a saved event query — cloudflare.get_eventqueryread

Returns a saved event query by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.query_id integer Required Event query ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a saved event query — cloudflare.patch_eventqueryupdate

Updates the given fields of a saved event query.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.query_id integer Required Event query ID
body object Optional
body.alert_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed.
body.alert_rollup_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed.
body.name string Optional Unique name for the saved query
body.query_json string Optional JSON string containing the query parameters
body.rule_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed.
body.rule_scope string Optional Deprecated and ignored: saved-query alerting and rules were removed.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a saved event query — cloudflare.post_eventqueryupdate

Updates the given fields of a saved event query.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.query_id integer Required Event query ID
body object Optional
body.alert_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed.
body.alert_rollup_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed.
body.name string Optional Unique name for the saved query
body.query_json string Optional JSON string containing the query parameters
body.rule_enabled boolean Optional Deprecated and ignored: saved-query alerting and rules were removed.
body.rule_scope string Optional Deprecated and ignored: saved-query alerting and rules were removed.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove event references (legacy) — cloudflare.delete_eventreferencedelete

Legacy. Removes references created with threat-intel events legacy references create. Use threat-intel events relationships for new event links.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
body object Optional
body.events array Required
body.events[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add event references (legacy) — cloudflare.post_eventreferencecreate

Legacy. Use threat-intel events relationships create (POST /events/relationships/create) instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
body object Optional
body.events array Required
body.events[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create event relationships — cloudflare.post_createeventrelationship

Creates directed relationships of type relationshipType from a parent event to one or more child events in the same dataset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.childIds array Required Array of UUIDs for child events. Single child = 1:1 relationship, multiple = 1:many relationships minItems: 1
body.childIds[] string Optional format: "uuid"
body.datasetId string Required Dataset identifier where the events are stored
body.parentId string Required UUID of the parent event that will be the source of the relationship format: "uuid"
body.relationshipType string Required Type of relationship to create between parent and child events enum: ["related_to","caused_by","attributed_to"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a tag category — cloudflare.delete_tagcategorydelete

Deletes a tag category by its UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.category_uuid string Required Tag Category UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a tag category — cloudflare.get_tagcategorydetail

Returns a tag category by its UUID, including the custom fields defined in its schema.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.category_uuid string Required Tag Category UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a tag category — cloudflare.patch_tagcategoryupdate

Updates the given fields of a tag category and leaves the other fields unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.category_uuid string Required Tag Category UUID.
body object Optional
body.description string Optional
body.name string Optional
body.schema array Optional Optional array of FieldDefinition objects. When provided, replaces the existing field schema. When omitted, the existing schema is preserved.
body.schema[] — Optional $ref: "#/definitions/cloudforce-one-events_FieldDefinition"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tags — cloudflare.get_taglist

Lists the account's tags. Use search to match tag values, categoryUuid to limit results to one category, and filters (a JSON array) to filter by fields such as originCountryISO, actorCategory, motive, or priority. Country filters accept alpha-2 or alpha-3 codes, names, or common aliases. Tags marked TLP:PURPLE are visible only to Cloudforce One.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.page number Optional
query.pageSize number Optional
query.search string Optional Free-text substring match on tag value AND custom-field properties. Searches case-insensitively inside both Tag.value and the serialized Tag.properties JSON blob (keys, values, and annotation metadata like confidence/tlp are all searchable). Same serialized-text tradeoff as aliasGroupNames — substrings can cross JSON boundaries.
query.categoryUuid string Optional
query.filters array Optional Structured filters as a JSON array of {field, op, value} objects. Searchable fields: uuid, value, categoryName, description, dateOfDiscovery, tlp, confidence, actorCategory, motive, attributionOrganization, originCountryISO, aliases, externalReferences, opsecLevel, sophisticationLevel, activeDuration, priority, lastSeen, aliasGroupNames. Operators: equals, not, contains, startsWith, endsWith, gt, lt, gte, lte, like, in, find. Use 'in' for bulk OR within a single field, e.g. filters=[{"field":"originCountryISO","op":"in","value":["IR","CN"]}]. Multiple entries are AND-joined. Max 10 entries per request, max 100 values per 'in'. Per-field notes: uuid accepts only 'equals' and 'in' (other operators throw ValidationError) — matched against the canonical lowercase storage but callers may pass either case (the server lowercases before comparison); index-backed by the column's UNIQUE constraint and intended for batched UUID → tag resolution. originCountryISO uses its B-tree index for equals/not/in. priority uses its B-tree index for numeric comparisons. Other string columns (actorCategory, motive, etc.) are case-insensitive and unindexed; current catalog size makes this a non-issue. endsWith and aliasGroupNames contains/like are leading-wildcard scans and slow on large result sets. aliasGroupNames matches on the JSON-encoded text, so substrings can cross alias boundaries (a search for "apt28" will also match "apt280" if both appear in the same tag's alias list).
query.filters[] object Optional
query.filters[].field string Required Tag field to search on. Allowed first-class fields: uuid, value, categoryName, description, dateOfDiscovery, tlp, confidence, actorCategory, motive, attributionOrganization, originCountryISO, aliases, externalReferences, opsecLevel, sophisticationLevel, activeDuration, priority, lastSeen, aliasGroupNames. Also supports properties.<key> to filter on custom field values (matches both raw values and annotated {value,confidence,tlp} shapes via COALESCE), and properties.<key>.tlp / properties.<key>.confidence to filter directly on annotation sub-fields.
query.filters[].op string Required Search operator. Use 'in' for bulk OR within a single field. enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find"]
query.filters[].value — Optional Search value. String or number for most operators. Array for 'in' (max 100 items).
query.filters[].value string Optional anyOf[1]
query.filters[].value number Optional anyOf[2]
query.filters[].value array Optional anyOf[3]
query.filters[].value[] — Optional anyOf[3]
query.filters[].value[] string Optional anyOf[3]; anyOf[1]
query.filters[].value[] number Optional anyOf[3]; anyOf[2]
query.cache string Optional Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. enum: ["from-graph"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tag categories — cloudflare.get_tagcategorylist

Lists the account's tag categories. Use search to filter them.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.search string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List threat actors — cloudflare.get_taggedactorlist

Lists threat actors from the Cloudforce One actor catalog. Use value to match actor names and filters to filter by fields such as origin country. Accounts outside Cloudforce One receive only public fields: identity, description, discovery date, TLP, confidence, custom properties, origin country, public aliases, and external references. Fields such as internal aliases, attribution, motive, and OPSEC level are omitted.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.page number Optional
query.pageSize number Optional
query.value string Optional Free-text substring match on actor name (Tag.value).
query.filters array Optional Structured filters as a JSON array of {field, op, value} objects. Same shape as the events search API. Common use: filter actors by country with filters=[{"field":"originCountryISO","op":"in","value":["IR","CN"]}]. Country values may be passed as alpha-2, alpha-3, name, or alias (e.g. "iran"). Max 10 entries per request, max 100 values per 'in'. Accounts other than the catalog owner may only filter on fields that are also public-readable (uuid, value, categoryName, aliasGroupNames, originCountryISO); filtering on a redacted field returns 400. uuid filters accept only the equals and in operators. Performance notes: originCountryISO uses its B-tree index for equals/in. endsWith and aliasGroupNames contains/like are leading-wildcard scans and slow on large result sets. aliasGroupNames matches on JSON-encoded text, so substrings can cross alias boundaries ("apt28" also matches "apt280" when both appear in the same tag's alias list).
query.filters[] object Optional
query.filters[].field string Required Tag field to search on. Allowed first-class fields: uuid, value, categoryName, description, dateOfDiscovery, tlp, confidence, actorCategory, motive, attributionOrganization, originCountryISO, aliases, externalReferences, opsecLevel, sophisticationLevel, activeDuration, priority, lastSeen, aliasGroupNames. Also supports properties.<key> to filter on custom field values (matches both raw values and annotated {value,confidence,tlp} shapes via COALESCE), and properties.<key>.tlp / properties.<key>.confidence to filter directly on annotation sub-fields.
query.filters[].op string Required Search operator. Use 'in' for bulk OR within a single field. enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find"]
query.filters[].value — Optional Search value. String or number for most operators. Array for 'in' (max 100 items).
query.filters[].value string Optional anyOf[1]
query.filters[].value number Optional anyOf[2]
query.filters[].value array Optional anyOf[3]
query.filters[].value[] — Optional anyOf[3]
query.filters[].value[] string Optional anyOf[3]; anyOf[1]
query.filters[].value[] number Optional anyOf[3]; anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a tag category — cloudflare.post_tagcategorycreate

Creates a tag category. Use schema to define the custom fields its tags can have.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.description string Optional
body.name string Required
body.schema array Optional Optional array of FieldDefinition objects defining custom fields for tags in this category. Persisted as JSON; returned as a parsed array.
body.schema[] — Optional $ref: "#/definitions/cloudforce-one-events_FieldDefinition"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a tag — cloudflare.post_tagcreate

Creates a tag in the account and returns the complete tag.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.activeDuration — Optional
body.activeDuration string Optional anyOf[1]
body.activeDuration object Optional anyOf[2]
body.activeDuration.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.activeDuration.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.activeDuration.value string Required anyOf[2]
body.actorCategory — Optional
body.actorCategory string Optional anyOf[1]
body.actorCategory object Optional anyOf[2]
body.actorCategory.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.actorCategory.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.actorCategory.value string Required anyOf[2]
body.aliasGroupNames array Optional
body.aliasGroupNames[] string Optional
body.aliasGroupNamesInternal array Optional
body.aliasGroupNamesInternal[] string Optional
body.aliases array Optional Structured aliases ({ value, confidence 1-10, tlp }). Public: returned to all accounts with per-entry TLP filtering (entries with tlp: purple are removed for non-CFONE accounts).
body.aliases[] object Optional
body.aliases[].confidence integer | null Optional minimum: 1; maximum: 10
body.aliases[].tlp string | null Optional enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.aliases[].value string Required
body.attributionOrganization — Optional
body.attributionOrganization string Optional anyOf[1]
body.attributionOrganization object Optional anyOf[2]
body.attributionOrganization.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.attributionOrganization.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.attributionOrganization.value string Required anyOf[2]
body.categoryUuid string Optional Tag type (category) UUID. Optional — when present, properties is validated against this category's schema. When absent, the tag is typeless and properties are accepted free-form.
body.confidence integer Optional Overall tag confidence (1-10). Optional. minimum: 1; maximum: 10
body.dateOfDiscovery string Optional Date of discovery (ISO YYYY-MM-DD). Optional. pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.description string Optional
body.externalReferenceLinks array Optional
body.externalReferenceLinks[] string Optional
body.externalReferences array Optional Structured external references ({ url, description }). Public: returned to all accounts.
body.externalReferences[] object Optional
body.externalReferences[].description string | null Optional
body.externalReferences[].url string Required
body.internalAliases array Optional Owner-private structured aliases ({ value, confidence 1-10, tlp }). Returned to the owning account and omitted from shared-catalog non-owner responses.
body.internalAliases[] object Optional
body.internalAliases[].confidence integer | null Optional minimum: 1; maximum: 10
body.internalAliases[].tlp string | null Optional enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.internalAliases[].value string Required
body.internalDescription string Optional
body.lastSeen string Optional
body.motive — Optional
body.motive string Optional anyOf[1]
body.motive object Optional anyOf[2]
body.motive.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.motive.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.motive.value string Required anyOf[2]
body.opsecLevel — Optional
body.opsecLevel string Optional anyOf[1]
body.opsecLevel object Optional anyOf[2]
body.opsecLevel.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.opsecLevel.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.opsecLevel.value string Required anyOf[2]
body.originCountryISO — Optional
body.originCountryISO string Optional anyOf[1]
body.originCountryISO object Optional anyOf[2]
body.originCountryISO.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.originCountryISO.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.originCountryISO.value string Required anyOf[2]
body.priority — Optional
body.priority number Optional anyOf[1]
body.priority object Optional anyOf[2]
body.priority.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.priority.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.priority.value number Required anyOf[2]
body.properties object Optional Structured metadata blob. Optional. When categoryUuid is given, validated against this category's schema on write. When typeless, accepted free-form. Use {} for a tag with no custom data. additionalProperties: true
body.sophisticationLevel — Optional
body.sophisticationLevel string Optional anyOf[1]
body.sophisticationLevel object Optional anyOf[2]
body.sophisticationLevel.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.sophisticationLevel.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.sophisticationLevel.value string Required anyOf[2]
body.tlp string Optional Tag-level TLP handling marking. Optional. Allowed values: red, amber, amber-strict, green, clear, purple, amber+strict. enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.value string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a tag — cloudflare.delete_tagdelete

Deletes a tag by its UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a tag — cloudflare.get_tagdetail

Returns a tag by its UUID, including its custom fields (properties). Tags marked TLP:PURPLE are visible only to Cloudforce One.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a tag — cloudflare.patch_tagupdate

Updates the given fields of a tag and returns the complete tag.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.
body object Optional
body.activeDuration — Optional
body.activeDuration string Optional anyOf[1]
body.activeDuration object Optional anyOf[2]
body.activeDuration.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.activeDuration.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.activeDuration.value string Required anyOf[2]
body.actorCategory — Optional
body.actorCategory string Optional anyOf[1]
body.actorCategory object Optional anyOf[2]
body.actorCategory.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.actorCategory.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.actorCategory.value string Required anyOf[2]
body.aliasGroupNames array Optional
body.aliasGroupNames[] string Optional
body.aliasGroupNamesInternal array Optional
body.aliasGroupNamesInternal[] string Optional
body.aliases array Optional Structured aliases ({ value, confidence 1-10, tlp }). Public: returned to all accounts with per-entry TLP filtering (entries with tlp: purple are removed for non-CFONE accounts).
body.aliases[] object Optional
body.aliases[].confidence integer | null Optional minimum: 1; maximum: 10
body.aliases[].tlp string | null Optional enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.aliases[].value string Required
body.attributionOrganization — Optional
body.attributionOrganization string Optional anyOf[1]
body.attributionOrganization object Optional anyOf[2]
body.attributionOrganization.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.attributionOrganization.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.attributionOrganization.value string Required anyOf[2]
body.categoryUuid string Optional Tag type (category) UUID. When changed, existing properties are re-validated against the new category's schema (400 on mismatch). Set to null to unlink (typeless; properties stop being validated).
body.confidence integer Optional Overall tag confidence (1-10). Omit to preserve existing. minimum: 1; maximum: 10
body.dateOfDiscovery string Optional Date of discovery (ISO YYYY-MM-DD). Omit to preserve existing. pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.description string Optional
body.externalReferenceLinks array Optional
body.externalReferenceLinks[] string Optional
body.externalReferences array Optional Structured external references ({ url, description }). Public: returned to all accounts.
body.externalReferences[] object Optional
body.externalReferences[].description string | null Optional
body.externalReferences[].url string Required
body.internalAliases array Optional Owner-private structured aliases ({ value, confidence 1-10, tlp }). Returned to the owning account and omitted from shared-catalog non-owner responses.
body.internalAliases[] object Optional
body.internalAliases[].confidence integer | null Optional minimum: 1; maximum: 10
body.internalAliases[].tlp string | null Optional enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.internalAliases[].value string Required
body.internalDescription string Optional
body.lastSeen string Optional
body.motive — Optional
body.motive string Optional anyOf[1]
body.motive object Optional anyOf[2]
body.motive.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.motive.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.motive.value string Required anyOf[2]
body.opsecLevel — Optional
body.opsecLevel string Optional anyOf[1]
body.opsecLevel object Optional anyOf[2]
body.opsecLevel.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.opsecLevel.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.opsecLevel.value string Required anyOf[2]
body.originCountryISO — Optional
body.originCountryISO string Optional anyOf[1]
body.originCountryISO object Optional anyOf[2]
body.originCountryISO.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.originCountryISO.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.originCountryISO.value string Required anyOf[2]
body.priority — Optional
body.priority number Optional anyOf[1]
body.priority object Optional anyOf[2]
body.priority.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.priority.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.priority.value number Required anyOf[2]
body.properties object Optional Custom field values blob. When omitted, the existing value is preserved. When provided, performs a shallow per-key merge over the stored value (unmentioned keys are retained). Setting an individual key to null deletes that key. Validation runs against the merged result, so a partial update may omit a schema-required key if the stored value supplies it. additionalProperties: true
body.sophisticationLevel — Optional
body.sophisticationLevel string Optional anyOf[1]
body.sophisticationLevel object Optional anyOf[2]
body.sophisticationLevel.confidence integer Optional anyOf[2]; minimum: 1; maximum: 10
body.sophisticationLevel.tlp string Optional anyOf[2]; enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.sophisticationLevel.value string Required anyOf[2]
body.tlp string Optional Tag-level TLP marking. Omit to preserve existing. Cannot be cleared to null. enum: ["red","amber","amber-strict","green","clear","purple","amber+strict"]
body.value string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a tag's indicators — cloudflare.get_tagindicatorslist

Lists the indicators that carry a tag, with pagination. By default, every intelligence dataset you can read is searched; use datasetIds to limit the search to specific datasets or a scope value. Analytics datasets don't store tag associations, so the analytics scope returns no results.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.
query object Optional additionalProperties: false
query.datasetIds array Optional Dataset UUIDs to scope to (repeat the param for multiple), or one standalone scope value: 'all'/'*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). Analytics datasets do not expose tag associations, so 'analytics' returns an empty result. Omit for 'all'.
query.datasetIds[] string Optional
query.page number Optional
query.pageSize number Optional
query.indicatorType string Optional
query.relatedEvent array Optional Filter indicators by related event UUID(s). Multiple UUIDs can be provided by repeating the parameter.
query.relatedEvent[] string Optional
query.search array Optional Structured search as a JSON array of {field, op, value} objects. Searchable fields: value, indicatorType. Multiple conditions are AND'd together. Max 10 conditions per request.
query.search[] object Optional
query.search[].field string Required The indicator field to search on. Allowed: value, indicatorType, uuid. enum: ["value","indicatorType","uuid"]
query.search[].op string Required Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}. enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find"]
query.search[].value — Required Search value. String for most operators. Array of strings for 'in' operator (max 100 items).
query.search[].value string Required anyOf[1]
query.search[].value array Required anyOf[2]
query.search[].value[] string Optional anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tag relationships — cloudflare.get_tagrelationshipslist

Lists the relationships that start at a tag, across the intelligence datasets you can read. Use datasets to limit the datasets (all and operational are equivalent here) and expand to include the related entities. Analytics datasets don't store tag associations, so the analytics scope returns no results.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.
query object Optional additionalProperties: false
query.datasets array Optional Comma-separated dataset UUIDs to scope to, or one standalone scope value: 'all'/'*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). Analytics datasets do not expose tag associations, so 'analytics' returns an empty result. Omit for 'all'.
query.datasets[] string Optional
query.search array Optional JSON array of {field, op, value} filters (same as indicator list search).
query.search[] object Optional
query.search[].field string Required entityType | type | confidence | metadata.<key>
query.search[].op string Required Search operator. 'exists' only valid for metadata.<key> fields. enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find","exists"]
query.search[].value — Optional Value to compare against. Omit for 'exists' op.
query.search[].value string Optional anyOf[1]
query.search[].value number Optional anyOf[2]
query.search[].value boolean Optional anyOf[3]
query.search[].value array Optional anyOf[4]
query.search[].value[] — Optional anyOf[4]
query.search[].value[] string Optional anyOf[4]; anyOf[1]
query.search[].value[] number Optional anyOf[4]; anyOf[2]
query.expand array Optional Comma-separated entity types to hydrate (event, indicator, tag).
query.expand[] string Optional
query.cursor string Optional Offset cursor from a previous page.
query.pageSize integer Optional Page size (1–100, default 25). default: 25; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a tag relationship — cloudflare.post_tagrelationshipcreate

Creates a relationship from a tag to an event or indicator (targetType) in the dataset given by datasetId. Relationships between two tags are not supported.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.
body object Optional
body.confidence integer Optional Confidence score 0–100. minimum: 0; maximum: 100
body.datasetId string Required Dataset UUID where the relationship row will be stored (locates the Indicators DO). minLength: 1
body.metadata object Optional Arbitrary JSON metadata. additionalProperties: true
body.targetId string Required UUID of the target entity. minLength: 1
body.targetType string Required Target type. "tag" is not allowed (tag↔tag relationships are not supported). enum: ["event","indicator"]
body.type string Required Relationship type. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a tag relationship — cloudflare.delete_tagrelationshipdelete

Deletes a tag relationship by its UUID. datasetId is required. Returns deleted: false if the relationship doesn't exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.
path.rel_uuid string Required Relationship UUID. format: "uuid"
query object Required additionalProperties: false
query.datasetId string Required Dataset UUID containing the relationship.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example",
    "rel_uuid": "00000000-0000-4000-8000-000000000000"
  },
  "query": {
    "datasetId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a tag relationship — cloudflare.patch_tagrelationshipupdate

Updates the given fields of a tag relationship and leaves the other fields unchanged. datasetId is required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.tag_uuid string Required Tag UUID.
path.rel_uuid string Required Relationship UUID. format: "uuid"
query object Required additionalProperties: false
query.datasetId string Required Dataset UUID containing the relationship.
body object Optional
body.confidence integer | null Optional Updated confidence. null clears it. minimum: 0; maximum: 100
body.metadata object | null Optional Updated metadata. null clears it. additionalProperties: true
body.type string Optional Updated relationship type. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "tag_uuid": "example",
    "rel_uuid": "00000000-0000-4000-8000-000000000000"
  },
  "query": {
    "datasetId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List target industries used in datasets — cloudflare.get_targetindustrylist

Lists the target industries referenced by events in the datasets given by datasetIds, or in the default dataset when datasetIds is omitted. To list every target industry, use threat-intel events target-industries catalog list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.datasetIds array Optional Array of dataset IDs to query target industries from. If not provided, uses the default dataset.
query.datasetIds[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all target industries — cloudflare.get_targetindustrylistcomplete

Lists every predefined target industry, whether or not an event uses it. To list only the industries used in specific datasets, use threat-intel events target-industries list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update events in bulk — cloudflare.patch_eventupdatebulk

Applies the same field values to up to 100 events in one dataset. The date field can't be changed in bulk.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.datasetId string Required Dataset ID containing the events to update. Required to prevent cross-account modifications.
body.eventIds array Required List of event UUIDs to update (1-100) minItems: 1; maxItems: 100
body.eventIds[] string Optional
body.updates object Required Fields to update on all specified events. All fields including 'insight' are supported, except 'date' which requires shard migration.
body.updates.attacker string | null Optional
body.updates.attackerCountry string Optional
body.updates.category string Optional
body.updates.createdAt string Optional format: "date-time"
body.updates.event string Optional
body.updates.indicator string Optional
body.updates.indicatorType string Optional
body.updates.insight string Optional
body.updates.raw object Optional
body.updates.raw.data object | null Optional additionalProperties: true
body.updates.raw.source string Optional
body.updates.raw.tlp string Optional
body.updates.targetCountry string Optional
body.updates.targetIndustry string Optional
body.updates.tlp string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an event — cloudflare.patch_eventupdate

Updates the given fields of an event and leaves the other fields unchanged. datasetId is required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
body object Optional
body.attacker string | null Optional
body.attackerCountry string Optional
body.category string Optional
body.createdAt string Optional format: "date-time"
body.datasetId string Required Dataset ID containing the event to update.
body.date string Optional format: "date-time"
body.event string Optional
body.indicator string Optional
body.indicatorType string Optional
body.insight string Optional
body.raw object Optional
body.raw.data object | null Optional additionalProperties: true
body.raw.source string Optional
body.raw.tlp string Optional
body.targetCountry string Optional
body.targetIndustry string Optional
body.tlp string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an event — cloudflare.post_eventupdate

Updates the given fields of an event and leaves the other fields unchanged. datasetId is required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
body object Optional
body.attacker string | null Optional
body.attackerCountry string Optional
body.category string Optional
body.createdAt string Optional format: "date-time"
body.datasetId string Required Dataset ID containing the event to update.
body.date string Optional format: "date-time"
body.event string Optional
body.indicator string Optional
body.indicatorType string Optional
body.insight string Optional
body.raw object Optional
body.raw.data object | null Optional additionalProperties: true
body.raw.source string Optional
body.raw.tlp string Optional
body.targetCountry string Optional
body.targetIndustry string Optional
body.tlp string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get raw event data by raw ID (legacy) — cloudflare.get_eventrawread

Legacy. Returns raw data stored under a raw_id, which new events don't use. Use threat-intel events raw get (GET /events/datasets/{dataset_id}/events/{event_id}/raw) instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
path.raw_id string Required Raw Event UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example",
    "raw_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update raw event data by raw ID (legacy) — cloudflare.patch_eventrawupdate

Legacy. Updates raw data stored under a raw_id, which new events don't use. There is no direct replacement.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
path.raw_id string Required Raw Event UUID.
body object Optional
body.data object Optional
body.source string Optional
body.tlp string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example",
    "raw_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update raw event data by raw ID (legacy) — cloudflare.post_eventrawupdate

Legacy. Updates raw data stored under a raw_id, which new events don't use. There is no direct replacement.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.event_id string Required Event UUID.
path.raw_id string Required Raw Event UUID.
body object Optional
body.data object Optional
body.source string Optional
body.tlp string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "event_id": "example",
    "raw_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Requests — cloudflare.cloudforce-one-request-list

Lists Cloudforce One intelligence requests with filtering and pagination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
body — Required $ref: "#/definitions/cloudforce-one-requests_request-list"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Request Priority, Status, and TLP constants — cloudflare.cloudforce-one-request-constants

Retrieves constant values used in Cloudforce One requests, including valid statuses and types.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a New Request. — cloudflare.cloudforce-one-request-new

Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
body — Required $ref: "#/definitions/cloudforce-one-requests_request-edit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Priority Intelligence Requirements — cloudflare.cloudforce-one-priority-list

Lists priority intelligence requests in Cloudforce One.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
body — Required $ref: "#/definitions/cloudforce-one-requests_priority-list"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a New Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-new

Creates a new priority intelligence request in Cloudforce One.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
body — Required $ref: "#/definitions/cloudforce-one-requests_priority-edit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "labels": [
      "DoS",
      "CVE"
    ],
    "priority": 1,
    "requirement": "DoS attacks carried out by CVEs",
    "tlp": "clear"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Priority Intelligence Requirement Quota — cloudflare.cloudforce-one-priority-quota

Retrieves quota usage for Cloudforce One priority requests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-delete

Deletes a priority intelligence request from Cloudforce One.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.priority_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "priority_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-get

Retrieves a specific priority intelligence request from Cloudforce One.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.priority_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "priority_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Priority Intelligence Requirement — cloudflare.cloudforce-one-priority-update

Updates a priority intelligence request in Cloudforce One.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.priority_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
body — Required $ref: "#/definitions/cloudforce-one-requests_priority-edit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "priority_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "labels": [
      "DoS",
      "CVE"
    ],
    "priority": 1,
    "requirement": "DoS attacks carried out by CVEs",
    "tlp": "clear"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Request Quota — cloudflare.cloudforce-one-request-quota

Retrieves quota usage for Cloudforce One standard requests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Request Types — cloudflare.cloudforce-one-request-types

Lists available request types for Cloudforce One intelligence requests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Request — cloudflare.cloudforce-one-request-delete

Deletes a Cloudforce One intelligence request and all associated data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Request — cloudflare.cloudforce-one-request-get

Retrieves details for a specific Cloudforce One intelligence request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Request — cloudflare.cloudforce-one-request-update

Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
body — Required $ref: "#/definitions/cloudforce-one-requests_request-edit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Request Assets — cloudflare.cloudforce-one-request-asset-list

Lists assets attached to a Cloudforce One intelligence request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
body — Required $ref: "#/definitions/cloudforce-one-requests_request-asset-list"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Request Asset — cloudflare.cloudforce-one-request-asset-delete

Removes an asset from a Cloudforce One intelligence request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
path.asset_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "asset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Request Asset — cloudflare.cloudforce-one-request-asset-get

Retrieves an asset attached to a Cloudforce One intelligence request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
path.asset_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "asset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Request Asset — cloudflare.cloudforce-one-request-asset-update

Updates an asset in a Cloudforce One intelligence request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
path.asset_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
body — Required $ref: "#/definitions/cloudforce-one-requests_request-asset-edit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "asset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Request Messages — cloudflare.cloudforce-one-request-message-list

Lists messages in a Cloudforce One intelligence request conversation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
body — Required $ref: "#/definitions/cloudforce-one-requests_request-message-list"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a New Request Message — cloudflare.cloudforce-one-request-message-new

Adds a message to a Cloudforce One intelligence request conversation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
body — Required $ref: "#/definitions/cloudforce-one-requests_request-message-edit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Request Message — cloudflare.cloudforce-one-request-message-delete

Removes a message from a Cloudforce One intelligence request thread.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
path.message_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "message_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Request Message — cloudflare.cloudforce-one-request-message-update

Updates a message in a Cloudforce One intelligence request thread.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-requests_identifier"
path.request_id — Required $ref: "#/definitions/cloudforce-one-requests_uuid"
path.message_id integer Required
body — Required $ref: "#/definitions/cloudforce-one-requests_request-message-edit"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "request_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "message_id": 1
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all rules — cloudflare.cloudforce-one-delete-all-rules

Delete all rules in an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List rules — cloudflare.cloudforce-one-list-rules

Returns all rules for an account with optional filtering.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Optional additionalProperties: false
query.namespace — Optional Selects namespaces. Repeat the parameter to select multiple namespaces (for example, namespace=foo&namespace=bar).
query.namespace string Optional anyOf[1]
query.namespace array Optional anyOf[2]; maxItems: 50
query.namespace[] string Optional anyOf[2]
query.path — Optional Selects paths with exact-match semantics. Omit the parameter to return rules from all paths. Pass an empty string (path=) to return only rules with an empty or uncategorized path. Pass a value (for example, path=yara) to match that exact path. Repeat the parameter (for example, path=yara&path=expr) to OR-match multiple paths with SQL IN (...) semantics. The recursive flag affects only customer-account namespace selection.
query.path string Optional anyOf[1]
query.path array Optional anyOf[2]; maxItems: 50
query.path[] string Optional anyOf[2]
query.recursive string Optional For customer accounts, true enables descendant matching for namespaces. Paths always use exact matching. enum: ["true","false"]
query.search string Optional
query.is_public string Optional Limits rules to the specified public visibility. enum: ["true","false"]
query.limit number Optional default: 50; minimum: 1; maximum: 100
query.offset number | null Optional default: 0; minimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a rule — cloudflare.cloudforce-one-create-rule

Create a new detection rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body — Optional $ref: "#/definitions/cloudforce-one_CreateRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List rule approvals — cloudflare.cloudforce-one-list-rule-approvals

Returns rule approvals with optional status, revision, reviewer-scope, and mutation-type filtering.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Optional additionalProperties: false
query.status — Optional Selects approval statuses. Repeat the parameter to OR-match statuses (for example, status=pending&status=rejected). Use status=all alone to disable status filtering. default: "pending"
query.status string Optional anyOf[1]; enum: ["pending","approved","rejected","cancelled","all"]
query.status array Optional anyOf[2]; minItems: 1; maxItems: 4
query.status[] string Optional anyOf[2]; enum: ["pending","approved","rejected","cancelled","all"]
query.latest_only string Optional When true, returns the newest revision in each approval chain. enum: ["true","false"]; default: "false"
query.limit number Optional default: 50; minimum: 1; maximum: 100
query.offset number | null Optional default: 0; minimum: 0
query.reviewer_scope string Optional Limits approvals to the specified reviewer scope. enum: ["default","email","unresolved"]
query.change_type string Optional Limits approvals to the specified mutation type. enum: ["create","update","delete"]
query.rule_id string Optional Filter approvals by rule ID. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get rule approval details — cloudflare.cloudforce-one-get-rule-approval

Get a single rule approval with current rule data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the approval.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a pending approval — cloudflare.cloudforce-one-cancel-rule-approval

Cancel a pending rule approval. Only its original requester may cancel it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the approval.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revise and resubmit a rejected approval — cloudflare.cloudforce-one-resubmit-rule-approval

Create a new pending revision from a rejected rule approval. Only the original requester may resubmit the latest revision.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the approval.
body — Optional $ref: "#/definitions/cloudforce-one_ResubmitApprovalRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove patterns from exemption rules — cloudflare.cloudforce-one-remove-account-exemptions

Remove regex patterns from per-account exemption rules. Missing keys leave that type untouched; non-existent patterns are silently skipped.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body — Optional $ref: "#/definitions/cloudforce-one_PartialAccountExemptions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get exemption rules for an account — cloudflare.cloudforce-one-get-exemptions

Get all exemption rule patterns for the account, grouped by type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add patterns to exemption rules — cloudflare.cloudforce-one-add-account-exemptions

Add regex patterns to per-account exemption rules (union semantics). Missing keys leave that type untouched; duplicates are silently deduped.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body — Optional $ref: "#/definitions/cloudforce-one_PartialAccountExemptions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update exemption rule patterns — cloudflare.cloudforce-one-update-account-exemptions

Replace existing exemption patterns with new values. Each key maps to an array of {old_pattern, new_pattern} entries. Missing keys leave that type untouched. Fails if any old pattern is not found or any new pattern already exists.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body — Optional $ref: "#/definitions/cloudforce-one_UpdateAccountExemptionsBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get managed rules — cloudflare.cloudforce-one-get-managed-rules

Get DFP managed rule metadata (name and description) from YARA rules.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search rules — cloudflare.cloudforce-one-search-rules

Search rules using hybrid, vector, keyword, or exact retrieval, backed by AI Search with a SQL fallback.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Required additionalProperties: false
query.namespace — Optional Selects namespaces. Repeat the parameter to select multiple namespaces (for example, namespace=foo&namespace=bar).
query.namespace string Optional anyOf[1]
query.namespace array Optional anyOf[2]; maxItems: 50
query.namespace[] string Optional anyOf[2]
query.path — Optional Selects paths with exact-match semantics. Omit the parameter to return rules from all paths. Pass an empty string (path=) to return only rules with an empty or uncategorized path. Pass a value (for example, path=yara) to match that exact path. Repeat the parameter (for example, path=yara&path=expr) to OR-match multiple paths with SQL IN (...) semantics. The recursive flag affects only customer-account namespace selection.
query.path string Optional anyOf[1]
query.path array Optional anyOf[2]; maxItems: 50
query.path[] string Optional anyOf[2]
query.recursive string Optional For customer accounts, true enables descendant matching for namespaces. Paths always use exact matching. enum: ["true","false"]
query.search string Optional
query.is_public string Optional Limits rules to the specified public visibility. enum: ["true","false"]
query.limit number Optional default: 50; minimum: 1; maximum: 100
query.offset number | null Optional default: 0; minimum: 0
query.query string Required Natural-language or keyword search query. minLength: 1; maxLength: 500
query.mode string Optional Retrieval strategy used for the query. enum: ["exact","hybrid","vector","keyword"]; default: "hybrid"
query.language string Optional Limits results to the specified rule language. enum: ["yara","js"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "query": "obfuscated proxy worker"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get dashboard stats — cloudflare.cloudforce-one-get-rule-stats

Get statistics about rules for the dashboard.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List email rules — cloudflare.cloudforce-one-list-email-rules

Returns structured email rules.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Optional additionalProperties: false
query.limit number Optional default: 50; minimum: 1; maximum: 100
query.offset number | null Optional default: 0; minimum: 0
query.search string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an email rule — cloudflare.cloudforce-one-create-email-rule

Create a structured email rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Optional
body.condition — Required $ref: "#/definitions/cloudforce-one_EmailRuleConditionGroup"
body.description string Optional maxLength: 1000
body.enabled boolean Optional default: true
body.meta array Optional maxItems: 50
body.meta[] — Optional $ref: "#/definitions/cloudforce-one_MetaInputEntry"
body.name string Required minLength: 1; maxLength: 255
body.status string Optional Disposition for matching email. This emits status metadata with the selected value. enum: ["silent","blocking"]; default: "silent"
body.strings array Optional default: []; maxItems: 50
body.strings[] object Optional
body.strings[].identifier string Required minLength: 1; maxLength: 128; pattern: "^[a-zA-Z_][a-zA-Z0-9_]*$"
body.strings[].match_type string Optional enum: ["text","hex","regex"]; default: "text"
body.strings[].modifiers array Optional default: []
body.strings[].modifiers[] string Optional enum: ["nocase","wide","ascii","fullword"]
body.strings[].type string Required enum: ["string_match"]
body.strings[].value string Required minLength: 1; maxLength: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a pending structured email rule approval — cloudflare.cloudforce-one-update-pending-email-rule-approval

Validate, compile, and replace the proposed structured email rule on a pending approval. Only the original requester may update it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the approval.
query object Optional additionalProperties: false
query.module string Optional Structured rule module. enum: ["eml"]; default: "eml"
body object Optional
body.condition — Required $ref: "#/definitions/cloudforce-one_EmailRuleConditionGroup"
body.description string Optional maxLength: 1000
body.enabled boolean Optional default: true
body.meta array Optional maxItems: 50
body.meta[] — Optional $ref: "#/definitions/cloudforce-one_MetaInputEntry"
body.name string Required minLength: 1; maxLength: 255
body.status string Optional Disposition for matching email. This emits status metadata with the selected value. enum: ["silent","blocking"]; default: "silent"
body.strings array Optional default: []; maxItems: 50
body.strings[] object Optional
body.strings[].identifier string Required minLength: 1; maxLength: 128; pattern: "^[a-zA-Z_][a-zA-Z0-9_]*$"
body.strings[].match_type string Optional enum: ["text","hex","regex"]; default: "text"
body.strings[].modifiers array Optional default: []
body.strings[].modifiers[] string Optional enum: ["nocase","wide","ascii","fullword"]
body.strings[].type string Required enum: ["string_match"]
body.strings[].value string Required minLength: 1; maxLength: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revise and resubmit a rejected structured email rule approval — cloudflare.cloudforce-one-resubmit-email-rule-approval

Validates and compiles a complete structured email rule, then creates an immutable pending revision of its rejected approval.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the approval.
query object Optional additionalProperties: false
query.module string Optional Structured rule module. enum: ["eml"]; default: "eml"
body object Optional
body.condition — Required $ref: "#/definitions/cloudforce-one_EmailRuleConditionGroup"
body.description string Optional maxLength: 1000
body.enabled boolean Optional default: true
body.meta array Optional maxItems: 50
body.meta[] — Optional $ref: "#/definitions/cloudforce-one_MetaInputEntry"
body.name string Required minLength: 1; maxLength: 255
body.status string Optional Disposition for matching email. This emits status metadata with the selected value. enum: ["silent","blocking"]; default: "silent"
body.strings array Optional default: []; maxItems: 50
body.strings[] object Optional
body.strings[].identifier string Required minLength: 1; maxLength: 128; pattern: "^[a-zA-Z_][a-zA-Z0-9_]*$"
body.strings[].match_type string Optional enum: ["text","hex","regex"]; default: "text"
body.strings[].modifiers array Optional default: []
body.strings[].modifiers[] string Optional enum: ["nocase","wide","ascii","fullword"]
body.strings[].type string Required enum: ["string_match"]
body.strings[].value string Required minLength: 1; maxLength: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get email rule schema — cloudflare.cloudforce-one-get-email-rule-schema

Get the field catalog for structured email rules.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate an email rule — cloudflare.cloudforce-one-validate-email-rule

Validates structured email rule syntax and metadata.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Optional
body.condition — Required $ref: "#/definitions/cloudforce-one_EmailRuleConditionGroup"
body.description string Optional maxLength: 1000
body.enabled boolean Optional default: true
body.existing_rule_id string Optional Existing rule ID to exclude from duplicate-name checks when validating an update. format: "uuid"
body.meta array Optional maxItems: 50
body.meta[] — Optional $ref: "#/definitions/cloudforce-one_MetaInputEntry"
body.name string Required minLength: 1; maxLength: 255
body.status string Optional Disposition for matching email. This emits status metadata with the selected value. enum: ["silent","blocking"]; default: "silent"
body.strings array Optional default: []; maxItems: 50
body.strings[] object Optional
body.strings[].identifier string Required minLength: 1; maxLength: 128; pattern: "^[a-zA-Z_][a-zA-Z0-9_]*$"
body.strings[].match_type string Optional enum: ["text","hex","regex"]; default: "text"
body.strings[].modifiers array Optional default: []
body.strings[].modifiers[] string Optional enum: ["nocase","wide","ascii","fullword"]
body.strings[].type string Required enum: ["string_match"]
body.strings[].value string Required minLength: 1; maxLength: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an email rule — cloudflare.cloudforce-one-delete-email-rule

Delete an existing structured email rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the rule. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an email rule — cloudflare.cloudforce-one-get-email-rule

Get a structured email rule by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the rule. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an email rule — cloudflare.cloudforce-one-update-email-rule

Updates an existing structured email rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the rule. format: "uuid"
body object Optional
body.condition — Optional $ref: "#/definitions/cloudforce-one_EmailRuleConditionGroup"
body.description string Optional maxLength: 1000
body.enabled boolean Optional
body.meta array Optional maxItems: 50
body.meta[] — Optional $ref: "#/definitions/cloudforce-one_MetaInputEntry"
body.name string Optional minLength: 1; maxLength: 255
body.status string Optional Disposition for matching email. This emits status metadata with the selected value. enum: ["silent","blocking"]
body.strings array Optional maxItems: 50
body.strings[] object Optional
body.strings[].identifier string Required minLength: 1; maxLength: 128; pattern: "^[a-zA-Z_][a-zA-Z0-9_]*$"
body.strings[].match_type string Optional enum: ["text","hex","regex"]; default: "text"
body.strings[].modifiers array Optional default: []
body.strings[].modifiers[] string Optional enum: ["nocase","wide","ascii","fullword"]
body.strings[].type string Required enum: ["string_match"]
body.strings[].value string Required minLength: 1; maxLength: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Test an email rule — cloudflare.cloudforce-one-test-email-rule

Test a structured email rule against sample email JSON.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the rule. format: "uuid"
body object Optional
body.sample_json string Required minLength: 1; maxLength: 16777216

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get folder tree structure — cloudflare.cloudforce-one-get-rule-tree

Get the folder tree structure for rules navigation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate rule with context — cloudflare.cloudforce-one-validate-rule

Validates rule syntax, name uniqueness, namespace, and metadata.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Optional
body.content string Required minLength: 1
body.excludeRuleId string Optional format: "uuid"
body.name string Required minLength: 1; maxLength: 255
body.namespaces array Optional default: []
body.namespaces[] string Optional minLength: 1; maxLength: 255
body.path string Optional minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a rule — cloudflare.cloudforce-one-delete-rule

Delete an existing rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the rule. format: "uuid"
body — Optional $ref: "#/definitions/cloudforce-one_DeleteRuleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a rule — cloudflare.cloudforce-one-get-rule

Get a single rule by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the rule. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a rule — cloudflare.cloudforce-one-update-rule

Updates an existing rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.id string Required The unique identifier for the rule. format: "uuid"
body — Optional $ref: "#/definitions/cloudforce-one_UpdateRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Scan Configs — cloudflare.get_configfetch

Lists scan configurations for Cloudforce One's network scanning service.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Defines the Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Scan Config — cloudflare.post_configcreate

Creates a new scan configuration for Cloudforce One's network scanning service.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Defines the Account ID.
body object Optional
body.frequency — Optional $ref: "#/definitions/cloudforce-one-port-scan-api_frequency"
body.ips — Required $ref: "#/definitions/cloudforce-one-port-scan-api_ips"
body.ports — Optional $ref: "#/definitions/cloudforce-one-port-scan-api_ports"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Scan Config — cloudflare.delete_deletescans

Deletes a scan configuration from Cloudforce One's network scanning service.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Defines the Account ID.
path.config_id string Required Defines the Config ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "config_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an existing Scan Config — cloudflare.post_configupdate

Updates an existing scan configuration in Cloudforce One's network scanning service.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Defines the Account ID.
path.config_id string Required Defines the Config ID.
body object Optional
body.frequency — Optional $ref: "#/definitions/cloudforce-one-port-scan-api_frequency"
body.ips — Optional $ref: "#/definitions/cloudforce-one-port-scan-api_ips"
body.ports — Optional $ref: "#/definitions/cloudforce-one-port-scan-api_ports"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "config_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Latest Scan Result — cloudflare.get_getopenports

Retrieves the latest scan results for a Cloudforce One scan configuration, including discovered open ports.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Defines the Account ID.
path.config_id string Required Defines the Config ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "config_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List saved query matches — cloudflare.get_domainmatchlist

Get paginated list of domain matches for one or more brand protection queries. When multiple query_ids are provided (comma-separated), matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and individual dismissed state.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Required additionalProperties: false
query.offset string Optional default: "0"
query.limit string Optional default: "50"
query.query_id array Required Query ID or comma-separated list of Query IDs. When multiple IDs are provided, matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and dismissed state.
query.query_id[] string Optional
query.include_domain_id string Optional default: "false"
query.include_dismissed string Optional
query.domain_search string Optional Filter matches by domain name (substring match)
query.orderBy string Optional Column to sort by. Options: 'domain', 'first_seen', or 'registrar' enum: ["domain","first_seen","registrar"]
query.order string Optional Sort order. Options: 'asc' (ascending) or 'desc' (descending) enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "query_id": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk dismiss or undismiss matches — cloudflare.post_bulkdismissmatches

Dismiss or undismiss multiple matches in a single request. Accepts either the new format (matches: [{query_id, domain_id}]) for per-query control, or the legacy format (match_ids: [number]) which dismisses for all queries sharing each match's hash. Returns per-item success/error results.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.action string Required enum: ["dismiss","undismiss"]
body.match_ids array Optional minItems: 1; maxItems: 100
body.match_ids[] integer Optional exclusiveMinimum: 0
body.matches array Optional minItems: 1; maxItems: 100
body.matches[] object Optional
body.matches[].domain_id integer Required exclusiveMinimum: 0
body.matches[].query_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get queries — cloudflare.get_getdomainqueries

Get all saved brand protection queries for an account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.id string Optional
query.page integer Optional Optional page number for paginated list requests. Defaults to 1 when only per_page is supplied. Omit page and per_page to preserve the legacy full-list response. maximum: 1000000; exclusiveMinimum: 0
query.per_page integer Optional Optional number of queries per page for paginated list requests. Defaults to 100 when only page is supplied. Maximum 100. Omit page and per_page to preserve the legacy full-list response. maximum: 100; exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Insert query — cloudflare.post_insertdomainquery

Create a new saved brand protection query with string match patterns

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.max_time string Optional
body.min_time string Optional
body.scan boolean Optional
body.scan_matches boolean Optional
body.search_lookback boolean Optional If true, search recent domain lookback entries for matches default: true
body.string_matches array Required minItems: 1; maxItems: 100
body.string_matches[] object Optional
body.string_matches[].pattern string Required minLength: 1; maxLength: 200
body.tag string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete domain query — cloudflare.delete_deletedomainquery

Delete a saved brand protection domain query from the account_queries table. This operation will remove the query from the durable object database. Returns 404 if the query ID doesn't exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.query_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update domain query — cloudflare.patch_updatedomainquery

Update a saved brand protection domain query with string match patterns

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.query_id string Required minLength: 1
body object Optional
body.max_time string Optional
body.min_time string Optional
body.scan boolean Optional
body.scan_matches boolean Optional
body.search_lookback boolean Optional If true, search recent domain lookback entries for matches default: true
body.string_matches array Required minItems: 1; maxItems: 100
body.string_matches[] object Optional
body.string_matches[].pattern string Required minLength: 1; maxLength: 200
body.tag string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Analyze domains for brand impersonation — cloudflare.post_domaintrial

Uses AI to scan all domains in the lookback table and identify potential phishing or impersonation attempts against the given brand string.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.brand string Required minLength: 1; maxLength: 200; pattern: "^[\\w\\s.-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate takedown letter — cloudflare.post_lettergenerate

Generate a takedown letter from a template. Returns V4 JSON for text format or a PDF binary for pdf format.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.createNotice boolean Optional default: false
body.fields object Required
body.fields.discoveryDate string Optional pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.fields.domain string Optional maxLength: 500
body.fields.generationDate string Optional pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.fields.jurisdiction string Optional maxLength: 500
body.fields.registrantEmail string Optional maxLength: 500
body.fields.registrar string Optional maxLength: 500
body.fields.registrarEmail string Optional maxLength: 500
body.fields.resolutionByDate string Optional pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.fields.senderCompany string Optional maxLength: 500
body.fields.senderEmail string Optional maxLength: 500
body.fields.senderName string Optional maxLength: 500
body.fields.senderTitle string Optional maxLength: 500
body.fields.trademarkName string Optional maxLength: 500
body.fields.trademarkNumber string Optional maxLength: 500
body.fields.trademarkOwner string Optional maxLength: 500
body.format string Optional enum: ["text","pdf"]; default: "text"
body.noticeParams object Optional
body.noticeParams.domain string Required minLength: 1; maxLength: 253
body.noticeParams.queryId integer Optional exclusiveMinimum: 0
body.noticeParams.status string Optional enum: ["draft","sent","resolved","expired"]; default: "sent"
body.templateId string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List letter templates — cloudflare.get_lettertemplatelist

List user-defined takedown letter templates. System example templates are available via the /templates/examples endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create letter template — cloudflare.post_lettertemplatecreate

Create a new user-defined takedown letter template

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.body string Required minLength: 1
body.category string Required minLength: 1; maxLength: 100
body.description string Optional maxLength: 1000
body.name string Required minLength: 1; maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List example letter templates — cloudflare.get_lettertemplateexamples

List system-provided example templates that can be used as starting points when creating custom templates. These templates cannot be used directly for letter generation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete letter template — cloudflare.delete_lettertemplatedelete

Delete a user-defined takedown letter template. System templates cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.template_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get letter template — cloudflare.get_lettertemplateget

Get a specific user-defined takedown letter template by ID. System example templates are available via the /templates/examples endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.template_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update letter template — cloudflare.put_lettertemplateupdate

Update a user-defined takedown letter template. System templates cannot be modified.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.template_id string Required minLength: 1
body object Optional
body.body string Optional minLength: 1
body.category string Optional minLength: 1; maxLength: 100
body.description string | null Optional maxLength: 1000
body.name string Optional minLength: 1; maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List logo matches — cloudflare.get_logomatchlist

Get paginated list of logo matches for a specific brand protection logo query

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Required additionalProperties: false
query.offset string Optional default: "0"
query.limit string Optional default: "50"
query.query_id string Required minLength: 1
query.download string Optional
query.orderBy string Optional Column to sort by. Options: 'matchedAt', 'domain', 'similarityScore', or 'registrar' enum: ["matchedAt","domain","similarityScore","registrar"]
query.order string Optional Sort order. Options: 'asc' (ascending) or 'desc' (descending) enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "query_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get logo queries — cloudflare.get_getlogoqueries

Get all saved brand protection logo queries for an account. Optionally specify id to get a single query. Set download=true to include base64-encoded image data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.id string Optional Optional query ID to retrieve a specific logo query
query.download string Optional If true, include base64-encoded image data in the response

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Insert logo query — cloudflare.post_insertlogoquery

Create a new saved brand protection logo query for visual similarity matching

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.image_data string Required Base64 encoded image data. Can include data URI prefix (e.g., 'data:image/png;base64,...') or just the base64 string. minLength: 1
body.search_lookback boolean Optional If true, search historic scanned images for matches above the similarity threshold default: true
body.similarity_threshold number Required Minimum similarity score (0-1) required for visual matches minimum: 0; maximum: 1
body.tag string Required Unique identifier for the logo query minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete logo query — cloudflare.delete_deletelogoquery

Delete a saved brand protection logo query. Returns 404 if the query ID doesn't exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.query_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search scanned images — cloudflare.post_searchlogosimilarity

Submit an image and find the n closest matches from the scanned images index without creating any match records. Returns similarity scores and metadata for each match.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.showHistoric string Optional Include scanned images without domain metadata (historic data). Default: false (only show images with domain) default: "false"
query.download string Optional If true, include base64-encoded image data in the response
body object Optional
body.image_data string Required Base64 encoded image data. Can include data URI prefix (e.g., 'data:image/png;base64,...') or just the base64 string. minLength: 1
body.score_threshold number Optional Minimum similarity score threshold for matches (0-1, default: 0) default: 0; minimum: 0; maximum: 1
body.top_k integer Optional Number of closest matches to return (1-100, default: 10) default: 10; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Dismiss a match — cloudflare.post_dismissmatch

Mark a specific domain as dismissed for a given query. Dismissals are per-query — dismissing a domain in one query does not affect other queries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.query_id integer Required exclusiveMinimum: 0
path.domain_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": 1,
    "domain_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Undismiss a match — cloudflare.post_undismissmatch

Remove the dismissed status from a specific domain for a given query. Undismissals are per-query — undismissing a domain in one query does not affect other queries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.query_id integer Required exclusiveMinimum: 0
path.domain_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "query_id": 1,
    "domain_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List takedown notices — cloudflare.get_takedownnoticelist

List all takedown notices for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create takedown notice — cloudflare.post_takedownnoticecreate

Create a new takedown notice for a domain suspected of trademark infringement.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.domain string Required minLength: 1; maxLength: 253
body.matchId integer Optional exclusiveMinimum: 0
body.matchType string Optional enum: ["logo","domain"]
body.queryId integer Optional exclusiveMinimum: 0
body.status string Optional enum: ["draft","sent","resolved","expired"]; default: "draft"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lookup takedown notices by domains — cloudflare.post_takedownnoticelookup

Bulk lookup of takedown notices by domain names. Returns an array of { domain, queryId, notice } entries (notice is null when no match exists). Supports optional queryId or queryIds to scope lookups per query. Uses POST to avoid URL length limits when looking up many domains. This endpoint is read-only. Domains are normalized (trimmed, lowercased) and deduplicated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.domains array Required minItems: 1; maxItems: 100
body.domains[] string Optional minLength: 1; maxLength: 253
body.queryId integer Optional exclusiveMinimum: 0
body.queryIds array Optional maxItems: 100
body.queryIds[] integer Optional exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete takedown notice — cloudflare.delete_takedownnoticedelete

Delete a takedown notice and all associated letters. PDFs are also removed from storage.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.notice_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "notice_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get takedown notice — cloudflare.get_takedownnoticeget

Get a specific takedown notice by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.notice_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "notice_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update takedown notice — cloudflare.put_takedownnoticeupdate

Update a takedown notice (e.g. change status to sent, resolved, etc.).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.notice_id integer Required exclusiveMinimum: 0
body object Optional
body.domain string Optional minLength: 1; maxLength: 253
body.matchId integer | null Optional exclusiveMinimum: 0
body.matchType string | null Optional enum: ["logo","domain"]
body.queryId integer | null Optional exclusiveMinimum: 0
body.status string Optional enum: ["draft","sent","resolved","expired"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "notice_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List takedown letters — cloudflare.get_takedownletterlist

List all letters for a specific takedown notice.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.notice_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "notice_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create takedown letter — cloudflare.post_takedownlettercreate

Generate a takedown letter for a notice and persist the rendered text. The PDF is generated lazily on download.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.notice_id integer Required exclusiveMinimum: 0
body object Optional
body.fields object Required
body.fields.discoveryDate string Optional pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.fields.domain string Optional maxLength: 500
body.fields.generationDate string Optional pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.fields.jurisdiction string Optional maxLength: 500
body.fields.registrantEmail string Optional maxLength: 500
body.fields.registrar string Optional maxLength: 500
body.fields.registrarEmail string Optional maxLength: 500
body.fields.resolutionByDate string Optional pattern: "^\\d{4}-\\d{2}-\\d{2}$"
body.fields.senderCompany string Optional maxLength: 500
body.fields.senderEmail string Optional maxLength: 500
body.fields.senderName string Optional maxLength: 500
body.fields.senderTitle string Optional maxLength: 500
body.fields.trademarkName string Optional maxLength: 500
body.fields.trademarkNumber string Optional maxLength: 500
body.fields.trademarkOwner string Optional maxLength: 500
body.templateId string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "notice_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete takedown letter — cloudflare.delete_takedownletterdelete

Delete a specific takedown letter and its associated PDF from storage.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.notice_id integer Required exclusiveMinimum: 0
path.letter_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "notice_id": 1,
    "letter_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get takedown letter — cloudflare.get_takedownletterget

Get a specific takedown letter by ID, including the rendered text.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.notice_id integer Required exclusiveMinimum: 0
path.letter_id integer Required exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "notice_id": 1,
    "letter_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get total queries — cloudflare.get_totalqueries

Get the total number of saved brand protection queries (domain + logo) for an account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List collections — cloudflare.get_collectionlist

Retrieves all collections for an account with pagination

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
query object Optional additionalProperties: false
query.page number Optional Page number
query.limit number Optional Items per page

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new collection — cloudflare.post_collectioncreate

Creates a collection with four patterns: schema-only (empty collection), rows-only (inferred schema), schema+rows (validated data), or file upload (CSV/JSON/JSONL)

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
body — Optional
body object Optional anyOf[1]
body.columns array Required anyOf[1]; minItems: 1; maxItems: 100
body.columns[] object Optional anyOf[1]
body.columns[].default object | null Optional Default value for the column (type depends on column type) anyOf[1]
body.columns[].name string Required anyOf[1]; minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_]+$"
body.columns[].required boolean Optional anyOf[1]; default: false
body.columns[].type string Required anyOf[1]; enum: ["text","number","boolean","date"]
body.description string Optional anyOf[1]; maxLength: 500
body.metadata object Optional anyOf[1]; additionalProperties: true
body.name string Required anyOf[1]; minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_]+$"
body.project_id string Optional anyOf[1]
body.tags array Optional anyOf[1]
body.tags[] string Optional anyOf[1]
body object Optional anyOf[2]
body.description string Optional anyOf[2]; maxLength: 500
body.metadata object Optional anyOf[2]; additionalProperties: true
body.name string Required anyOf[2]; minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_]+$"
body.project_id string Optional anyOf[2]
body.rows array Required anyOf[2]; minItems: 1; maxItems: 1000
body.rows[] object Optional anyOf[2]; additionalProperties: true
body.tags array Optional anyOf[2]
body.tags[] string Optional anyOf[2]
body object Optional anyOf[3]
body.columns array Required anyOf[3]; minItems: 1; maxItems: 100
body.columns[] object Optional anyOf[3]
body.columns[].default object | null Optional Default value for the column (type depends on column type) anyOf[3]
body.columns[].name string Required anyOf[3]; minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_]+$"
body.columns[].required boolean Optional anyOf[3]; default: false
body.columns[].type string Required anyOf[3]; enum: ["text","number","boolean","date"]
body.description string Optional anyOf[3]; maxLength: 500
body.metadata object Optional anyOf[3]; additionalProperties: true
body.name string Required anyOf[3]; minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_]+$"
body.project_id string Optional anyOf[3]
body.rows array Required anyOf[3]; minItems: 1; maxItems: 1000
body.rows[] object Optional anyOf[3]; additionalProperties: true
body.tags array Optional anyOf[3]
body.tags[] string Optional anyOf[3]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete collection — cloudflare.delete_collectiondelete

Deletes a collection and all its items. This action cannot be undone. The Durable Object storage is deleted asynchronously.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.collection_id string Required Collection UUID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get collection — cloudflare.get_collectionget

Retrieves a single collection by ID with its schema and metadata

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.collection_id string Required Collection UUID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update collection — cloudflare.patch_collectionupdate

Updates collection name and/or metadata. Schema (columns) cannot be modified.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.collection_id string Required Collection UUID
body object Optional
body.metadata object Optional
body.metadata.description string Optional Collection description
body.metadata.project_id string Optional Project ID
body.metadata.tags array Optional
body.metadata.tags[] string Optional
body.name string Optional Collection name

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add column to collection — cloudflare.post_columnadd

Adds a new column to an existing collection schema. Existing items will have NULL for the new column unless a default value is provided.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.collection_id string Required Collection UUID
body object Optional
body.default object | null Optional
body.name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_]+$"
body.required boolean Optional default: false
body.type string Required enum: ["text","number","boolean","date"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "10d79d097895ae7ed7942a2b3832186c",
    "collection_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete column — cloudflare.delete_columndelete

Delete a column from the collection schema. Data is preserved as orphaned UUID keys (forensic safety) and filtered from API responses.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.collection_id string Required
path.column_id string Required Column UUID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example",
    "column_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update column — cloudflare.patch_columnupdate

Update name, type, required, or position of a column.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.collection_id string Required
path.column_id string Required Column UUID
body object Optional
body.name string Optional New column name (must be unique)
body.position number Optional Column display order
body.required boolean Optional Whether column is required
body.type string Optional Column type: text, number, boolean, or date enum: ["text","number","boolean","date"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example",
    "column_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export collection to CSV, JSONL, or Markdown — cloudflare.get_collectionexportendpoint

Streams collection data in the requested format. Supports CSV (default), JSONL, or Markdown via Accept header. Queries items in batches of 1000 to avoid memory/timeout limits.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID (hex format)
path.collection_id string Required Collection UUID
query object Optional additionalProperties: false
query.include_ids boolean Optional Include item IDs in export (default: false)
headers object Optional additionalProperties: false
headers.accept string Optional Requested format: text/csv (default), application/x-ndjson, text/markdown

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query collection items — cloudflare.get_itemquery

Retrieves items from a collection with keyset pagination and optional column-based filters

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.collection_id string Required Collection UUID
query object Optional additionalProperties: false
query.cursor string Optional Opaque pagination cursor from a previous response. Omit for the first page.
query.limit number Optional Items per page
query.q string Optional Case-insensitive substring search across all columns. Matches any column containing the term. No relevance ranking. minLength: 1; maxLength: 500

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create item(s) — cloudflare.post_itemcreate

Create one or more items in a collection. Supports single item (data field) or bulk creation (data array). Item data is validated against the collection schema.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.collection_id string Required
body — Optional
body object Optional anyOf[1]
body.data object Required Single item data matching collection schema anyOf[1]; additionalProperties: true
body object Optional anyOf[2]
body.data array Required Array of items to create (max 1000) anyOf[2]; minItems: 1; maxItems: 1000
body.data[] object Optional anyOf[2]; additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete collection item — cloudflare.delete_itemdelete

Delete an item from a collection by its identifier.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.collection_id string Required
path.item_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example",
    "item_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get collection item — cloudflare.get_itemget

Retrieve a single item from a collection by its identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.collection_id string Required
path.item_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example",
    "item_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update collection item — cloudflare.patch_itemupdate

Update an item in a collection with partial data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.collection_id string Required
path.item_id string Required
body object Optional
body.data object Required additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example",
    "item_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search items (advanced filtering) — cloudflare.post_itemsearch

Search collection items with advanced filtering. Supports operators (eq, neq, gt, lt, gte, lte, contains, is_empty, is_not_empty) and AND/OR logic for complex queries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.collection_id string Required Collection UUID
body object Optional
body.cursor string Optional
body.filter object Optional Recursive filter supporting AND/OR nesting of conditions. Can be either a leaf condition (field/op/value) or a logical group (and/or array of nested filters).
body.filter object Optional Leaf filter condition oneOf[1]
body.filter.field string Required Column name to filter on oneOf[1]
body.filter.op string Required Comparison operator oneOf[1]; enum: ["eq","neq","gt","lt","gte","lte","contains","is_empty","is_not_empty"]
body.filter.value — Optional Value to compare against (not needed for is_empty/is_not_empty) oneOf[1]
body.filter.value string | null Optional oneOf[1]; oneOf[1]
body.filter.value number Optional oneOf[1]; oneOf[2]
body.filter.value boolean Optional oneOf[1]; oneOf[3]
body.filter.value array Optional oneOf[1]; oneOf[4]
body.filter.value[] — Optional oneOf[1]; oneOf[4]
body.filter.value[] string Optional oneOf[1]; oneOf[4]; oneOf[1]
body.filter.value[] number Optional oneOf[1]; oneOf[4]; oneOf[2]
body.filter.value[] boolean Optional oneOf[1]; oneOf[4]; oneOf[3]
body.filter.value[] object Optional oneOf[1]; oneOf[4]; oneOf[4]; additionalProperties: true
body.filter.value object Optional oneOf[1]; oneOf[5]; additionalProperties: true
body.filter object Optional oneOf[2]
body.filter.and array Required All conditions must match (AND logic). Each item can recursively contain more filters. oneOf[2]; minItems: 1
body.filter.and[] object Optional Nested filter (can be a leaf condition or another AND/OR group) oneOf[2]
body.filter object Optional oneOf[3]
body.filter.or array Required At least one condition must match (OR logic). Each item can recursively contain more filters. oneOf[3]; minItems: 1
body.filter.or[] object Optional Nested filter (can be a leaf condition or another AND/OR group) oneOf[3]
body.limit integer Optional default: 20; minimum: 1; maximum: 100
body.q string Optional Case-insensitive substring search across all columns. Matches any column containing the term. No relevance ranking. minLength: 1; maxLength: 500
body.sort object Optional
body.sort.field string Required Column name to sort by
body.sort.order string Optional enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "collection_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List monitored domains — cloudflare.get_domainlist

List all domains registered for credential monitoring.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
query object Optional additionalProperties: false
query.page integer Optional Page number default: 1; exclusiveMinimum: 0
query.per_page integer Optional Items per page default: 100; maximum: 100; exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create monitored domain — cloudflare.post_domaincreate

Register a domain for credential monitoring.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
body object Optional
body.domain string Required Domain to monitor (e.g. my-company.com)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete monitored domain — cloudflare.delete_domaindelete

Remove a domain from credential monitoring.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.id integer Required Domain ID exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List credential matches — cloudflare.get_matchlist

Get credential matches for the account's monitored domains.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
query object Optional additionalProperties: false
query.domain string Optional Filter by domain (exact match)
query.username string Optional Filter by username (partial match)
query.page integer Optional Page number default: 1; exclusiveMinimum: 0
query.per_page integer Optional Items per page default: 100; maximum: 1000; exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run a GraphQL aggregation over events (legacy) — cloudflare.post_eventgraphqlv2

Legacy. Use threat-intel events graphql (POST /events/graphql) instead. Both commands run the same query.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List priority intelligence requirements for an account — cloudflare.get_pirlist

Lists free-form Priority Intelligence Requirements for the account. Results are scoped to the authenticated account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a priority intelligence requirement — cloudflare.post_pircreate

Creates a new PIR for the account. The cfone.priority_intelligence_requirement_limit entitlement sets how many PIRs can be active; drafts do not count, but the account can hold at most five times that many PIRs in total. An active PIR requires a query.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional
body.dataset_scope — Optional default: every event dataset the account can read: Cloudforce One intelligence, datasets shared with the account, and the account's own datasets, such as Threat Signals. datasets: explicit dataset IDs. Analytics datasets are not matched. An active PIR can cover at most 50 datasets. Access is rechecked whenever the PIR is matched.
body.dataset_scope object Optional oneOf[1]; additionalProperties: false
body.dataset_scope.type string Required oneOf[1]; enum: ["default"]
body.dataset_scope object Optional oneOf[2]; additionalProperties: false
body.dataset_scope.dataset_ids array Required oneOf[2]; minItems: 1; maxItems: 50
body.dataset_scope.dataset_ids[] string Optional oneOf[2]; format: "uuid"
body.dataset_scope.type string Required oneOf[2]; enum: ["datasets"]
body.digest_interval_hours integer Optional Hours between digests: 6, 12, or 24. Used only when notification_mode is digest. enum: [6,12,24]; default: 24
body.intent object Optional additionalProperties: false
body.intent.clauses array Required minItems: 1; maxItems: 8
body.intent.clauses[] object Optional additionalProperties: false
body.intent.clauses[].actors array Required maxItems: 20
body.intent.clauses[].actors[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].attacker_countries array Required maxItems: 20
body.intent.clauses[].attacker_countries[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].categories array Required maxItems: 20
body.intent.clauses[].categories[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].cves array Required maxItems: 20
body.intent.clauses[].cves[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].keywords array Required maxItems: 5
body.intent.clauses[].keywords[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].target_countries array Required maxItems: 20
body.intent.clauses[].target_countries[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].target_industries array Required maxItems: 20
body.intent.clauses[].target_industries[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].techniques array Required maxItems: 20
body.intent.clauses[].techniques[] string Optional minLength: 1; maxLength: 200
body.intent.indicators array Required maxItems: 20
body.intent.indicators[] string Optional minLength: 1; maxLength: 200
body.intent.unsupported_terms array Required maxItems: 20
body.intent.unsupported_terms[] string Optional minLength: 1; maxLength: 200
body.labels array Optional default: []; maxItems: 50
body.labels[] string Optional maxLength: 100
body.model string Optional minLength: 1; maxLength: 200
body.notification_mode string Optional none or digest. Notifications are opt-in. immediate is reserved and currently rejected. enum: ["none","immediate","digest"]; default: "none"
body.priority integer Optional default: 0; minimum: 0
body.query object Optional additionalProperties: false
body.query.branches array Required Event List searchBranches: filters within a branch are ANDed, branches are ORed. minItems: 1; maxItems: 8
body.query.branches[] array Optional minItems: 1; maxItems: 10
body.query.branches[][] — Optional
body.query.branches[][] object Optional anyOf[1]; additionalProperties: false
body.query.branches[][].field string Required anyOf[1]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.query.branches[][].op string Required anyOf[1]; enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","find"]
body.query.branches[][].value string Required anyOf[1]; minLength: 1; maxLength: 512
body.query.branches[][] object Optional anyOf[2]; additionalProperties: false
body.query.branches[][].field string Required anyOf[2]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.query.branches[][].op string Required anyOf[2]; enum: ["in"]
body.query.branches[][].value array Required anyOf[2]; minItems: 1; maxItems: 100
body.query.branches[][].value[] string Optional anyOf[2]; minLength: 1; maxLength: 512
body.query.branches[][] object Optional anyOf[3]; additionalProperties: false
body.query.branches[][].field string Required anyOf[3]; enum: ["killChain"]
body.query.branches[][].op string Required anyOf[3]; enum: ["equals","not","gt","gte","lt","lte"]
body.query.branches[][].value — Required anyOf[3]
body.query.branches[][].value number Required anyOf[3]; anyOf[1]
body.query.branches[][].value string Required anyOf[3]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.query.branches[][] object Optional anyOf[4]; additionalProperties: false
body.query.branches[][].field string Required anyOf[4]; enum: ["killChain"]
body.query.branches[][].op string Required anyOf[4]; enum: ["in"]
body.query.branches[][].value array Required anyOf[4]; minItems: 1; maxItems: 100
body.query.branches[][].value[] — Optional anyOf[4]
body.query.branches[][].value[] number Optional anyOf[4]; anyOf[1]
body.query.branches[][].value[] string Optional anyOf[4]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.query.branches[][] object Optional anyOf[5]; additionalProperties: false
body.query.branches[][].field string Required anyOf[5]; enum: ["hasChildren"]
body.query.branches[][].op string Required anyOf[5]; enum: ["equals","not","gt","gte","lt","lte"]
body.query.branches[][].value — Required anyOf[5]
body.query.branches[][].value boolean Required anyOf[5]; anyOf[1]
body.query.branches[][].value string Required anyOf[5]; anyOf[2]; enum: ["true"]
body.query.branches[][].value string Required anyOf[5]; anyOf[3]; enum: ["false"]
body.query.branches[][].value number Required anyOf[5]; anyOf[4]; enum: [1]
body.query.branches[][].value number Required anyOf[5]; anyOf[5]; enum: [0]
body.query.branches[][].value string Required anyOf[5]; anyOf[6]; enum: ["1"]
body.query.branches[][].value string Required anyOf[5]; anyOf[7]; enum: ["0"]
body.query.branches[][] object Optional anyOf[6]; additionalProperties: false
body.query.branches[][].field string Required anyOf[6]; enum: ["hasChildren"]
body.query.branches[][].op string Required anyOf[6]; enum: ["in"]
body.query.branches[][].value array Required anyOf[6]; minItems: 1; maxItems: 100
body.query.branches[][].value[] — Optional anyOf[6]
body.query.branches[][].value[] boolean Optional anyOf[6]; anyOf[1]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[2]; enum: ["true"]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[3]; enum: ["false"]
body.query.branches[][].value[] number Optional anyOf[6]; anyOf[4]; enum: [1]
body.query.branches[][].value[] number Optional anyOf[6]; anyOf[5]; enum: [0]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[6]; enum: ["1"]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[7]; enum: ["0"]
body.query.version integer Optional Ignored. Accepted so a PIR read from the API can be sent back unchanged.
body.query_source string Optional enum: ["generated","edited"]
body.requirement string Required minLength: 1; maxLength: 4000
body.status string Optional draft: not monitored. active: monitored, unless pause_reason is set. Setting active on a PIR with a pause_reason resumes it. Moving a PIR back to draft and activating it again starts matching afresh with a 30-day backfill. enum: ["draft","active"]; default: "draft"
body.title string Optional minLength: 1; maxLength: 200
body.tlp string Optional default: "amber"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get PIR constants (methods, dimensions, and TLP values) — cloudflare.get_pirconstants

Requirements is the existing free-form PIR method. Interests is the experimental structured-interest method, evaluated independently from requirements.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate event filters from a PIR — cloudflare.post_pirfiltergenerate

Translates a natural-language Priority Intelligence Requirement into Threat Events searchBranches with Workers AI. Terms that cannot be expressed as event filters are returned in unresolved_terms. Nothing is stored or executed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional additionalProperties: false
body.requirement string Required Natural-language Priority Intelligence Requirement. minLength: 1; maxLength: 4000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account interests for PIR Option 2 — cloudflare.get_pirinterestlist

Lists structured account interests for Priority Intelligence Option 2. Filter by enabled state and paginate results.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
query object Optional additionalProperties: false
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.enabled string Optional enum: ["true","false"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an account interest for PIR Option 2 — cloudflare.post_pirinterestcreate

Creates a structured account interest used by Priority Intelligence Option 2 evaluations. Interests are evaluated independently from free-form PIR requirements.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
body object Optional
body.dimension string Required enum: ["actor","targetIndustry","category","country","attackerCountry","targetCountry","mitreAttack","killChain","mitreCapec"]
body.enabled boolean Optional default: true
body.value string Required minLength: 1; maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Backtest account-interest change detection — cloudflare.post_pirinterestbacktestcreate

Uses bounded full-span top-N candidates and daily event-date buckets. Results are conservative rather than an exact historical replay.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
body object Optional
body.as_of string Optional format: "date-time"
body.backtest_days integer Optional default: 30; minimum: 1; maximum: 90
body.candidate_limit integer Optional minimum: 1; maximum: 100
body.dataset_ids array Optional minItems: 1; maxItems: 50
body.dataset_ids[] string Optional minLength: 1
body.emerging_min_current_count integer Optional minimum: 1; maximum: 100000
body.established_min_absolute_delta integer Optional minimum: 1; maximum: 100000
body.established_min_prior_count integer Optional minimum: 1; maximum: 100000
body.established_min_relative_delta number | null Optional minimum: 0; maximum: 100
body.window_days integer Optional default: 7; minimum: 1; maximum: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a persisted account-interest backtest — cloudflare.get_pirinterestbacktestget

Returns a previously completed account-interest backtest by ID. The backtest must belong to this account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
path.backtest_id string Required Backtest UUID format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "backtest_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Evaluate recent event-dated changes for account interests — cloudflare.post_pirinterestevaluationcreate

Compares the trailing event-date window with the preceding window. Results are precision-gated to enabled account interests. Late ingestion can cause an older event to appear in a later evaluation, so results describe changes in event-dated intelligence rather than exact adversary-activity timing.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
body object Optional
body.as_of string Optional format: "date-time"
body.candidate_limit integer Optional minimum: 1; maximum: 100
body.dataset_ids array Optional minItems: 1; maxItems: 50
body.dataset_ids[] string Optional minLength: 1
body.emerging_min_current_count integer Optional minimum: 1; maximum: 100000
body.established_min_absolute_delta integer Optional minimum: 1; maximum: 100000
body.established_min_prior_count integer Optional minimum: 1; maximum: 100000
body.established_min_relative_delta number | null Optional minimum: 0; maximum: 100
body.window_days integer Optional default: 7; minimum: 1; maximum: 30

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a persisted account-interest evaluation — cloudflare.get_pirinterestevaluationget

Returns a previously completed live account-interest evaluation by ID. The evaluation must belong to this account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
path.evaluation_id string Required Evaluation UUID format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "evaluation_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an account interest for PIR Option 2 — cloudflare.delete_pirinterestdelete

Deletes a structured account interest so later Priority Intelligence Option 2 evaluations no longer include it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
path.interest_id string Required Interest UUID format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "interest_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an account interest for PIR Option 2 — cloudflare.patch_pirinterestupdate

Updates a structured account interest used by Priority Intelligence Option 2 evaluations. Changing the value re-resolves the interest against the current catalog.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID minLength: 1
path.interest_id string Required Interest UUID format: "uuid"
body object Optional
body.enabled boolean Optional
body.value string Optional minLength: 1; maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "interest_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Count matched events across the account's priority intelligence requirements — cloudflare.get_pirallmatchaggregates

Returns each active PIR's match counts, with the same fields and filters as a single PIR's aggregate, and the number of distinct values of each field across all of them, each value counted once. Counts are not summed across PIRs: an event can match several PIRs. Drafts are left out; PIRs the matcher paused are included. A PIR whose matches cannot be counted is returned with error and left out of combined. Requires the Threat Events entitlement.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
query object Required additionalProperties: false
query.aggregate_by string Required Comma-separated fields to count: tags, attacker, attacker_country, target_industry, indicator, indicator_type. indicator is each event's primary indicator, the first one it was created with. minLength: 1; maxLength: 200
query.limit integer Optional Top values returned per field. default: 10; minimum: 1; maximum: 100
query.since string Optional Only matches first matched at or after this ISO 8601 time. format: "date-time"
query.triage_state string Optional Only matches in this triage state. enum: ["new","relevant","not_relevant"]
query.include_backfill string Optional Include matches from the 30 days before activation. Defaults to true. enum: ["true","false"]; default: "true"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "aggregate_by": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete the organization profile — cloudflare.delete_pirprofiledelete

Deletes the account's organization profile. Succeeds when the account has no profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the organization profile — cloudflare.get_pirprofileget

Returns the account's organization profile, which all of its Priority Intelligence Requirements share to judge how relevant intelligence is to the organization. result is null when the account has no profile.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or replace the organization profile — cloudflare.put_pirprofileput

Creates or replaces the account's organization profile: who the organization is, such as its name, brands, domains, sector, regions, key systems and suppliers. All of the account's Priority Intelligence Requirements share it. An account has at most one profile, and it does not count against the PIR quota.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
body object Optional additionalProperties: false
body.profile string Required Who the organization is: its name, brands, domains, sector, regions, key systems and suppliers. Shared by all of the account's PIRs to judge how relevant intelligence is to the organization. minLength: 1; maxLength: 4000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get PIR quota for an account — cloudflare.post_pirquota

Returns the account's PIR quota. quota and remaining count active PIRs against the entitlement limit; moving a PIR to draft or deleting it frees its slot. total_quota and total_remaining count every PIR, drafts included, against five times the limit. Anniversary dates are informational.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a priority intelligence requirement — cloudflare.delete_pirdelete

Soft-deletes a PIR. The PIR will no longer count against quota.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.priority_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "priority_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a priority intelligence requirement by ID — cloudflare.get_pirget

Returns a single free-form Priority Intelligence Requirement for the authenticated account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.priority_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "priority_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a priority intelligence requirement — cloudflare.put_pirupdate

Updates a Priority Intelligence Requirement for the authenticated account. Changing the query increments its version; editing the requirement without saving a query marks the query stale. Activating a draft needs a free slot in the active PIR quota; setting active on a PIR the matcher paused resumes it without one.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.priority_id string Required format: "uuid"
body object Optional
body.confirm_query boolean Optional Write-only. true confirms the query still fits the requirement, clearing query_stale without changing the query or its version. Requires a query.
body.dataset_scope — Optional default: every event dataset the account can read: Cloudforce One intelligence, datasets shared with the account, and the account's own datasets, such as Threat Signals. datasets: explicit dataset IDs. Analytics datasets are not matched. An active PIR can cover at most 50 datasets. Access is rechecked whenever the PIR is matched.
body.dataset_scope object Optional oneOf[1]; additionalProperties: false
body.dataset_scope.type string Required oneOf[1]; enum: ["default"]
body.dataset_scope object Optional oneOf[2]; additionalProperties: false
body.dataset_scope.dataset_ids array Required oneOf[2]; minItems: 1; maxItems: 50
body.dataset_scope.dataset_ids[] string Optional oneOf[2]; format: "uuid"
body.dataset_scope.type string Required oneOf[2]; enum: ["datasets"]
body.digest_interval_hours integer Optional Hours between digests: 6, 12, or 24. Used only when notification_mode is digest. enum: [6,12,24]
body.intent object | null Optional additionalProperties: false
body.intent.clauses array Required minItems: 1; maxItems: 8
body.intent.clauses[] object Optional additionalProperties: false
body.intent.clauses[].actors array Required maxItems: 20
body.intent.clauses[].actors[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].attacker_countries array Required maxItems: 20
body.intent.clauses[].attacker_countries[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].categories array Required maxItems: 20
body.intent.clauses[].categories[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].cves array Required maxItems: 20
body.intent.clauses[].cves[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].keywords array Required maxItems: 5
body.intent.clauses[].keywords[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].target_countries array Required maxItems: 20
body.intent.clauses[].target_countries[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].target_industries array Required maxItems: 20
body.intent.clauses[].target_industries[] string Optional minLength: 1; maxLength: 200
body.intent.clauses[].techniques array Required maxItems: 20
body.intent.clauses[].techniques[] string Optional minLength: 1; maxLength: 200
body.intent.indicators array Required maxItems: 20
body.intent.indicators[] string Optional minLength: 1; maxLength: 200
body.intent.unsupported_terms array Required maxItems: 20
body.intent.unsupported_terms[] string Optional minLength: 1; maxLength: 200
body.labels array Optional maxItems: 50
body.labels[] string Optional maxLength: 100
body.model string | null Optional minLength: 1; maxLength: 200
body.notification_mode string Optional none or digest. Notifications are opt-in. immediate is reserved and currently rejected. enum: ["none","immediate","digest"]
body.priority integer Optional minimum: 0
body.query object | null Optional additionalProperties: false
body.query.branches array Required Event List searchBranches: filters within a branch are ANDed, branches are ORed. minItems: 1; maxItems: 8
body.query.branches[] array Optional minItems: 1; maxItems: 10
body.query.branches[][] — Optional
body.query.branches[][] object Optional anyOf[1]; additionalProperties: false
body.query.branches[][].field string Required anyOf[1]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.query.branches[][].op string Required anyOf[1]; enum: ["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","find"]
body.query.branches[][].value string Required anyOf[1]; minLength: 1; maxLength: 512
body.query.branches[][] object Optional anyOf[2]; additionalProperties: false
body.query.branches[][].field string Required anyOf[2]; enum: ["attacker","attackerCountry","category","createdAt","date","event","indicator","indicatorType","mitreAttack","mitreCapec","tags","targetCountry","targetIndustry","tlp","uuid"]
body.query.branches[][].op string Required anyOf[2]; enum: ["in"]
body.query.branches[][].value array Required anyOf[2]; minItems: 1; maxItems: 100
body.query.branches[][].value[] string Optional anyOf[2]; minLength: 1; maxLength: 512
body.query.branches[][] object Optional anyOf[3]; additionalProperties: false
body.query.branches[][].field string Required anyOf[3]; enum: ["killChain"]
body.query.branches[][].op string Required anyOf[3]; enum: ["equals","not","gt","gte","lt","lte"]
body.query.branches[][].value — Required anyOf[3]
body.query.branches[][].value number Required anyOf[3]; anyOf[1]
body.query.branches[][].value string Required anyOf[3]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.query.branches[][] object Optional anyOf[4]; additionalProperties: false
body.query.branches[][].field string Required anyOf[4]; enum: ["killChain"]
body.query.branches[][].op string Required anyOf[4]; enum: ["in"]
body.query.branches[][].value array Required anyOf[4]; minItems: 1; maxItems: 100
body.query.branches[][].value[] — Optional anyOf[4]
body.query.branches[][].value[] number Optional anyOf[4]; anyOf[1]
body.query.branches[][].value[] string Optional anyOf[4]; anyOf[2]; pattern: "^-?(?:\\d+\\.?\\d*|\\.\\d+)$"
body.query.branches[][] object Optional anyOf[5]; additionalProperties: false
body.query.branches[][].field string Required anyOf[5]; enum: ["hasChildren"]
body.query.branches[][].op string Required anyOf[5]; enum: ["equals","not","gt","gte","lt","lte"]
body.query.branches[][].value — Required anyOf[5]
body.query.branches[][].value boolean Required anyOf[5]; anyOf[1]
body.query.branches[][].value string Required anyOf[5]; anyOf[2]; enum: ["true"]
body.query.branches[][].value string Required anyOf[5]; anyOf[3]; enum: ["false"]
body.query.branches[][].value number Required anyOf[5]; anyOf[4]; enum: [1]
body.query.branches[][].value number Required anyOf[5]; anyOf[5]; enum: [0]
body.query.branches[][].value string Required anyOf[5]; anyOf[6]; enum: ["1"]
body.query.branches[][].value string Required anyOf[5]; anyOf[7]; enum: ["0"]
body.query.branches[][] object Optional anyOf[6]; additionalProperties: false
body.query.branches[][].field string Required anyOf[6]; enum: ["hasChildren"]
body.query.branches[][].op string Required anyOf[6]; enum: ["in"]
body.query.branches[][].value array Required anyOf[6]; minItems: 1; maxItems: 100
body.query.branches[][].value[] — Optional anyOf[6]
body.query.branches[][].value[] boolean Optional anyOf[6]; anyOf[1]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[2]; enum: ["true"]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[3]; enum: ["false"]
body.query.branches[][].value[] number Optional anyOf[6]; anyOf[4]; enum: [1]
body.query.branches[][].value[] number Optional anyOf[6]; anyOf[5]; enum: [0]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[6]; enum: ["1"]
body.query.branches[][].value[] string Optional anyOf[6]; anyOf[7]; enum: ["0"]
body.query.version integer Optional Ignored. Accepted so a PIR read from the API can be sent back unchanged.
body.query_source string | null Optional enum: ["generated","edited"]
body.requirement string Optional minLength: 1; maxLength: 4000
body.status string Optional draft: not monitored. active: monitored, unless pause_reason is set. Setting active on a PIR with a pause_reason resumes it. Moving a PIR back to draft and activating it again starts matching afresh with a 30-day backfill. enum: ["draft","active"]
body.title string | null Optional minLength: 1; maxLength: 200
body.tlp string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "priority_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a priority intelligence requirement's matched events — cloudflare.get_pirmatcheslist

Returns the events matched by the PIR's query, newest match first. Each item has the Event List event fields plus the match fields. Only datasets the account can read now are included, and deleted events are left out, so a page can hold fewer items than per_page while result_info.cursor is still set. backfill matches came from the 30 days before the PIR was activated or its query changed and are never notified. delivered matches were included in a digest that the notification service accepted; who receives it depends on the account's notification policies for the PIR. Requires the Threat Events entitlement.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.priority_id string Required format: "uuid"
query object Optional additionalProperties: false
query.cursor string Optional result_info.cursor from the previous page. Omit for the newest matches. maxLength: 512
query.per_page integer Optional Matches per page. default: 50; minimum: 1; maximum: 100
query.triage_state string Optional Only matches in this triage state. enum: ["new","relevant","not_relevant"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "priority_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Triage a priority intelligence requirement's matched events — cloudflare.patch_pirmatchestriage

Sets triage_state (new, relevant, or not_relevant) on up to 100 matches. Matches that do not exist, or are in datasets the account can no longer read, are returned in not_found. Setting new clears triaged_at and triaged_by. Requires the Threat Events entitlement.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.priority_id string Required format: "uuid"
body object Optional additionalProperties: false
body.matches array Required Up to 100 matches to set the triage state on. minItems: 1; maxItems: 100
body.matches[] object Optional additionalProperties: false
body.matches[].dataset_id string Required The match's datasetId. format: "uuid"
body.matches[].event_id string Required The match's event uuid. format: "uuid"
body.triage_state string Required enum: ["new","relevant","not_relevant"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "priority_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Count a priority intelligence requirement's matched events — cloudflare.get_pirmatchaggregates

Counts the PIR's matches by tag, attacker, attacker country, target industry, primary indicator, or indicator type: the top values, the number of distinct values, and the matches without a value. Covers the same matches as the matches list, in datasets the account can read now. Tags are grouped case-insensitively and shown with their most common spelling; an event counts once for each of its tags. indicator is the first indicator each event was created with. Field values are copied when an event matches; matches still being copied are reported in matches.pending and not counted, and matches whose event was already gone when its fields were copied in matches.missing. Counts keep the copied values, so an event deleted later stays counted. Requires the Threat Events entitlement.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.priority_id string Required format: "uuid"
query object Required additionalProperties: false
query.aggregate_by string Required Comma-separated fields to count: tags, attacker, attacker_country, target_industry, indicator, indicator_type. indicator is each event's primary indicator, the first one it was created with. minLength: 1; maxLength: 200
query.limit integer Optional Top values returned per field. default: 10; minimum: 1; maximum: 100
query.since string Optional Only matches first matched at or after this ISO 8601 time. format: "date-time"
query.triage_state string Optional Only matches in this triage state. enum: ["new","relevant","not_relevant"]
query.include_backfill string Optional Include matches from the 30 days before activation. Defaults to true. enum: ["true","false"]; default: "true"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "priority_id": "00000000-0000-4000-8000-000000000000"
  },
  "query": {
    "aggregate_by": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Count a priority intelligence requirement's matched events per day — cloudflare.get_pirmatchseries

Returns the PIR's matches per UTC day of when each matched event was added to its dataset, over the same matches as the matches list, in datasets the account can read now. Every day in the range is listed, including days with no matches. The range defaults to the last 30 days and is at most 90 days, because matches are kept for 90 days. Days before the PIR was activated hold only the most recent backfill matches. Requires the Threat Events entitlement.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required minLength: 1
path.priority_id string Required format: "uuid"
query object Optional additionalProperties: false
query.since string Optional Start of the range, inclusive, on when each matched event was added to its dataset. ISO 8601; defaults to 30 days before until. format: "date-time"
query.until string Optional End of the range, exclusive. ISO 8601; defaults to now. The range is at most 90 days. format: "date-time"
query.triage_state string Optional Only matches in this triage state. enum: ["new","relevant","not_relevant"]
query.include_backfill string Optional Include matches from the 30 days before activation. Defaults to true. enum: ["true","false"]; default: "true"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "priority_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check if current user is allowlisted for Legal Response — cloudflare.get_legalresponseaccesscheck

Returns whether the JWT-authenticated user's email is on the legal-response allowlist. This endpoint is purely informational for UI gating; actual access enforcement is performed by legalResponseMiddleware on real legal-response endpoints. Read-only — no Durable Object writes are performed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID (used for JWT validation only)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List RFIs — cloudflare.get_requestlist

Retrieves a paginated list of RFIs with filtering and sorting options.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.project_type string Required RFI project type enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]
query object Optional additionalProperties: false
query.page number Optional
query.pageSize number Optional
query.status string Optional Status filter. Projects with a narrowed dashboard vocabulary accept only their customer-facing values.
query.search string Optional
query.createdBy string Optional Filter by creator email. NOTE: For the legal-response project type this query parameter is rejected with HTTP 400 — the server derives the filter from the authenticated user's JWT automatically and does not accept a client-supplied value. Requests to legal-response with no valid JWT identity are rejected with HTTP 401.
query.assignee string Optional
query.requestType string Optional
query.priority string Optional
query.tlp string Optional
query.id string Optional
query.readableId string Optional
query.summary string Optional
query.accountId string Optional
query.metadata string Optional JSON string object of metadata filters. Supports two formats: 1) Simple values for exact match (backward compatible): {"status": "open"} 2) Operator objects for advanced filtering: {"identifiers": {"operator": "contains_line", "value": "blah.com"}}. Available operators: 'eq' (exact match, default), 'contains' (substring match), 'contains_line' (match complete line in newline-separated text). Date fields are automatically normalized to YYYY-MM-DD format.
query.orderBy string Optional Sort field. SOC Communications support customer-safe latest_activity ordering.
query.order string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a new RFI — cloudflare.post_requestcreate

Creates a new Request for Information with the specified project type and details.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.project_type string Required RFI project type enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]
body object Optional
body.description string Optional RFI description (optional). Defaults to an empty string when omitted.
body.eventId string | null Optional Optional related event ID
body.metadata object Optional Optional metadata fields specific to the RFI type additionalProperties: true
body.priority string Optional RFI priority. Four-level projects use low, routine, high, urgent; existing projects retain legacy low->routine compatibility. medium, critical, and unknown remain accepted legacy aliases. Defaults to routine. enum: ["low","routine","high","urgent","unknown","medium","critical"]
body.request_type string | null Optional Optional request type for the request
body.subtypeId string | null Optional Optional subtype ID
body.title string Optional RFI title (optional). When omitted, the server generates a summary from the request type and readable ID.
body.tlp string Optional Traffic Light Protocol level. Canonical values are clear, green, amber, amber-strict, red, purple. white and amber+strict are accepted input aliases; responses always use the canonical spelling. enum: ["clear","green","amber","amber-strict","red","purple","white","amber+strict"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get request constants — cloudflare.get_requestconstants

Returns available priorities, statuses, and TLP levels for request workflows

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.project_type string Required Project type enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List metadata fields for an RFI type — cloudflare.get_dashboardmetadatafieldlist

Get custom metadata fields available for the specified project type

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.project_type string Required Project type enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]
query object Optional additionalProperties: false
query.request_type string Optional Filter fields to those applicable to this request type. Fields without request type restrictions are always included.
query.country string Optional Exclude fields restricted for this alpha-2 country code minLength: 2; maxLength: 2; pattern: "^[A-Z]{2}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get request token quota — cloudflare.get_requestquota

Returns the account's token quota for the current anniversary quarter: total granted, used, remaining, and the quarter/anniversary boundaries.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.project_type string Required RFI project type enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List visible request types for a project (dashboard) — cloudflare.get_dashboardrequesttypeslist

Returns request types available to dashboard (external) callers. For restricted project types (e.g. legal-response), only the allowlisted subset is returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.project_type string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get current user profile — cloudflare.get_usergetself

Get the current user's profile in a specific RFI project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID
path.project_type string Required RFI project type

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an RFI by ID — cloudflare.get_requestread

Retrieves a specific RFI by its UUID with related data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.project_type string Required RFI project type. Valid values: threat-intelligence, incident-response, ir-emergency-response, table-top, pentest, irp, threat-hunting, cybersecurity-assessment, react-general, legal-response, soc-alerts, demo enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]
path.request_id string Required RFI UUID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence",
    "request_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an RFI — cloudflare.put_requestupdate

Updates an existing RFI with the provided fields. Only provided fields will be updated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.project_type string Required RFI project type. Valid values: threat-intelligence, incident-response, ir-emergency-response, table-top, pentest, irp, threat-hunting, cybersecurity-assessment, react-general, legal-response, soc-alerts, demo enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]
path.request_id string Required RFI UUID
body object Optional
body.description string Optional RFI description
body.eventId string Optional Optional related event ID
body.priority string Optional RFI priority. Four-level projects use a distinct low level; existing projects retain legacy low->routine compatibility. medium, critical, and unknown remain accepted legacy aliases. enum: ["low","routine","high","urgent","unknown","medium","critical"]
body.request_type string Optional Request type. May only be changed while the request is still open; changing it recalculates the request's token cost.
body.subtypeId string Optional Optional subtype ID
body.summary string Optional RFI summary
body.title string Optional RFI title (alias for summary field)
body.tlp string Optional Traffic Light Protocol level. white and amber+strict are accepted input aliases; responses always use the canonical spelling. enum: ["clear","green","amber","amber-strict","red","purple","white","amber+strict"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence",
    "request_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List assets in request (Customer) — cloudflare.get_dashboardassetlist

List all file assets for a request. Customer can only list assets from their own account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.project_type string Required RFI project type. Valid values: threat-intelligence, incident-response, ir-emergency-response, table-top, pentest, irp, threat-hunting, cybersecurity-assessment, react-general, legal-response, soc-alerts, demo enum: ["threat-intelligence","incident-response","ir-emergency-response","table-top","pentest","irp","threat-hunting","cybersecurity-assessment","react-general","legal-response","soc-alerts","demo"]
path.request_id string Required RFI UUID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "threat-intelligence",
    "request_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List messages for an RFI request — cloudflare.get_messagelist

Retrieves the published, non-deleted messages visible to the agent for an RFI request, with pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.project_type string Required
path.request_id string Required
query object Optional additionalProperties: false
query.page string Optional default: "1"
query.per_page string Optional default: "10"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "example",
    "request_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a customer follow-on message on an RFI request — cloudflare.post_messagecreate

Creates a customer dashboard message on an RFI request. Messages are always published on send. Workflow-enabled projects require Idempotency-Key and atomically record message activity and any policy transition. For token-billed project types, substantive follow-on messages consume message tokens and are subject to quarterly quota enforcement.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.project_type string Required
path.request_id string Required
headers object Optional additionalProperties: false
headers.Idempotency-Key string | null Optional Client command key. Required when publishing a message for a workflow-enabled project; trimmed and limited to 255 characters.
body object Optional
body.attachment_asset_ids array Optional
body.attachment_asset_ids[] string Optional
body.author_id string Optional
body.author_name string Optional
body.content string Required minLength: 1
body.publish boolean Optional default: false
body.tlp string Optional enum: ["clear","green","amber","amber-strict","red","white"]; default: "red"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "example",
    "request_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read a single message for an RFI request — cloudflare.get_messageread

Returns the details for a specific message belonging to an RFI request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.project_type string Required
path.request_id string Required
path.message_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "example",
    "request_id": "example",
    "message_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update/publish a message for an RFI request — cloudflare.put_messageupdate

Updates an existing message, typically to publish a draft by setting publish=true. Workflow-enabled publication requires Idempotency-Key and atomically records message activity and any policy transition.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.project_type string Required
path.request_id string Required
path.message_id string Required
headers object Optional additionalProperties: false
headers.Idempotency-Key string | null Optional Client command key. Required when publishing a message for a workflow-enabled project; trimmed and limited to 255 characters.
body object Optional
body.attachment_asset_ids array Optional
body.attachment_asset_ids[] string Optional
body.content string Required minLength: 1
body.publish boolean Required
body.tlp string Required enum: ["clear","green","amber","amber-strict","red","white"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "project_type": "example",
    "request_id": "example",
    "message_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search threat intelligence — cloudflare.searchthreatintelligence

Searches the articles, actors, tags, events, and indicators you can read and returns one list of typed results, most relevant first. Use entity_types to limit the types searched.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID. minLength: 1
body object Optional
body.entity_types array Optional Entity types to search. Omit to search articles, actors, tags, events, and indicators. default: ["article","actor","tag","event","indicator"]; minItems: 1; maxItems: 5
body.entity_types[] string Optional enum: ["article","actor","tag","event","indicator"]
body.include_analytics_datasets boolean Optional Whether to include Event and Indicator matches from analytics datasets. Defaults to false because these datasets can take longer to search. When omitted or false, those matches are intentionally excluded and source completeness covers only the backends that were queried. default: false
body.limit integer Optional Maximum number of results to return. Defaults to 20. default: 20; minimum: 1; maximum: 20
body.query string Required Search text, from 1 to 1000 characters after trimming. minLength: 1; maxLength: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Threat Signals articles — cloudflare.rssarticlelist

Lists articles from the account's Threat Signals feeds.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.cursor string Optional Opaque cursor from a previous response's next_cursor. When provided, pagination, ordering, totals, and article filters come from the cursor. Sending per_page, sort, include_total, or any article filter alongside it returns a 400 CursorFilterConflictError. minLength: 1
query.per_page integer Optional Number of articles per cursor page, from 1 to 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.feed_id string Optional Feed UUID filter. Omit to include articles from every account feed. format: "uuid"
query.article_id array Optional Repeatable article UUID filter. Returns the union of matching account-owned articles; use this to list every Threat Signals article referenced by an indicator's sources. minItems: 1; maxItems: 90
query.article_id[] string Optional format: "uuid"
query.read boolean Optional Filter by read state. Accepts true, false, 1, or 0; omit to include read and unread articles.
query.tag_id array Optional Repeatable tag UUID filter. An article matches any selected tag.
query.tag_id[] string Optional format: "uuid"
query.tag_category_id array Optional Repeatable tag-category UUID filter. An article matches any selected category; when tag_id is also present, the tag and category groups are ANDed. minItems: 1; maxItems: 90
query.tag_category_id[] string Optional format: "uuid"
query.tag string Optional Legacy human-readable tag-value filter. Ignored when tag_id is supplied; prefer tag_id.
query.tag_category string Optional Legacy category-name disambiguator for tag. It has no effect without tag; prefer tag_category_id.
query.include_total boolean Optional When true on the first page, count matching articles and return an exact total. Defaults to false; cursor pages do not recalculate totals. default: false
query.search string Optional NFC-normalized, trimmed literal substring filter on article titles; ASCII case-insensitive, from 1 to 500 characters. minLength: 1; maxLength: 500
query.published_after string Optional Include articles published at or after this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.published_before string Optional Include articles published at or before this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.fetched_after string Optional Include articles fetched at or after this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.fetched_before string Optional Include articles fetched at or before this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.feed_category string Optional Exact feed-category filter after trimming. Omit to include every category.
query.source_type string Optional Filter by curated or custom feed source. Omit to include both source types. enum: ["curated","custom"]
query.tag_applied_by string Optional Assignment provenance filter. When combined with tag_id or tag_category_id, the matching assignment must have this provenance. enum: ["ai","analyst","system"]
query.pir_id string Optional Beta. Active Priority Intelligence Requirement to report, filter, and sort relevance by. Omit to use each article's most relevant active PIR. Returns a 400 error unless the PIR is active. format: "uuid"
query.min_relevance string Optional Beta. Return only articles at or above this relevance band for pir_id, or for any active PIR when pir_id is omitted. Excludes articles that have not been scored. enum: ["low","medium","high"]
query.severity array Optional Beta. Repeatable intrinsic severity band filter. An article matches any selected band, the band reported as its severity. Excludes articles without a severity. Like the severity field, severity is reported only while the account has an active Priority Intelligence Requirement; otherwise no articles match. minItems: 1; maxItems: 5
query.severity[] string Optional enum: ["informational","low","medium","high","critical"]
query.sort string Optional Sort by fetched_at, published_at, title, or relevance (beta). Prefix the field with - for descending order; defaults to -fetched_at. -relevance lists the most relevant articles first, by pir_id or by each article's most relevant active PIR, with unscored articles last. default: "-fetched_at"; pattern: "^-?(fetched_at|published_at|title|relevance)$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk update Threat Signals article read status — cloudflare.rssarticlebulkmarkread

Marks up to 50 Threat Signals articles as read or unread.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.article_ids array Required Array of article UUIDs to mark (1-50). minItems: 1; maxItems: 50
body.article_ids[] string Optional format: "uuid"
body.read boolean Required True to mark read, false to mark unread.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Count Threat Signals articles by relevance band — cloudflare.rssarticlerelevanceaggregate

Beta. Counts the account's Threat Signals articles in each relevance band, for each active Priority Intelligence Requirement and across all of them. Uses the same PIRs as article relevance: active PIRs, including those the matcher paused; drafts and deleted PIRs are excluded. Articles not scored against a PIR are not counted for it. The combined counts place each article once, in the band of its best score, so they are not the sum of the per-PIR counts. read counts only read or only unread articles. All counts are read together and are exact.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.published_after string Optional Include articles published at or after this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.published_before string Optional Include articles published at or before this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.read boolean Optional Filter by read state. Accepts true, false, 1, or 0; omit to include read and unread articles.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Count Threat Signals articles by severity band — cloudflare.rssarticleseverityaggregate

Beta. Counts the account's Threat Signals articles in each intrinsic severity band. An article's band is the one reported as its severity, from informational to critical. Articles without a severity are not counted. Also counts, for each active Priority Intelligence Requirement, the articles scored against it. min_relevance counts only articles at or above a relevance band: overall, for any active PIR; per PIR, for that PIR, the same rule as the per-PIR relevance counts. pir_id counts for one active PIR only. read counts only read or only unread articles, in both articles and priorities. Like the article severity field, severity is reported only while the account has an active Priority Intelligence Requirement, including one the matcher paused; otherwise every count is zero and priorities is empty. All counts are read together and are exact.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.published_after string Optional Include articles published at or after this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.published_before string Optional Include articles published at or before this ISO 8601 date-time with Z or a numeric UTC offset; normalized to UTC. format: "date-time"
query.read boolean Optional Filter by read state. Accepts true, false, 1, or 0; omit to include read and unread articles.
query.pir_id string Optional Beta. Active Priority Intelligence Requirement to count for. articles then counts only articles scored against it, min_relevance applies to its score, and priorities lists only it. Returns a 400 error unless the PIR is active. format: "uuid"
query.min_relevance string Optional Beta. Count only articles at or above this relevance band: in articles, for any active Priority Intelligence Requirement, as the article list's min_relevance does without pir_id; in each priority, for that PIR. Excludes articles that have not been scored against an active PIR. enum: ["low","medium","high"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Threat Signals article — cloudflare.rssarticleget

Retrieves a Threat Signals article with its summary, tags, indicator status and relevance to the account's Priority Intelligence Requirements.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Threat Signals article read status — cloudflare.rssarticlemarkread

Marks a Threat Signals article as read or unread.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"
body object Optional
body.read boolean Required True to mark the article read, false to mark unread.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Threat Signals article content — cloudflare.rssarticlecontentget

Retrieves the stored content of a Threat Signals article, unchanged. Depending on how the article was captured from its source, the content is HTML, Markdown, or plain text. The format parameter sets only the response Content-Type; it does not convert the content.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"
query object Optional additionalProperties: false
query.format string Optional Response Content-Type: text (the default) for text/plain or html for text/html. Neither value converts the content. html is deprecated; use text. enum: ["text","html"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reprocess a Threat Signals article — cloudflare.rssarticlereprocess

Synchronously re-runs every processing step for a Threat Signals article: pull content, clean content, extract IOCs, filter IOCs, summary, CVE tags, IOC context, article tags, and Event publication. Replaces the article's summary, AI tags, and indicators; indicators no longer found are removed. Creates a Threat Event only when the article has none; an existing Event is never updated. Takes over the article from any queued processing. Requires a paid Threat Signals subscription and the Cloudforce One Write permission.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"
body object Optional additionalProperties: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Threat Signals article custom skills — cloudflare.rssarticlecustomskillslist

Lists active custom skills currently assigned to the article's feed and whether each has a stored output. Output content and skill configuration are retrieved separately. Free Threat Signals accounts cannot read Custom Skills.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Threat Signals article skill output — cloudflare.rssarticleskilloutputget

Retrieves the stored output of a skill for a Threat Signals article. The custom_output field is parsed JSON when the stored output is valid JSON, otherwise the raw string.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"
path.skill_id string Required Custom Skill UUID or a Managed Default Skill ID (IOC-context: default-ioc-context-skill)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000",
    "skill_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run and persist skill output for a Threat Signals article — cloudflare.rssarticleskillrun

Run an active Custom Skill assigned to the article's feed, or run a managed default skill. Requires a paid Threat Signals subscription and the Cloudforce One Write permission. Always persists output; rerunning overwrites the previous result. Does not expose diagnostic model data or accept server-preview inputs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"
path.skill_id — Required UUID of an active Custom Skill that is assigned to the article's feed, or a managed default skill ID. Requires a paid Threat Signals subscription and the Cloudforce One Write permission. Always persists output; rerunning overwrites the previous result. No diagnostic or server-preview inputs.
path.skill_id string Required anyOf[1]; enum: ["default-tagging-skill","default-ioc-context-skill","default-summary-skill"]
path.skill_id string Required anyOf[2]; format: "uuid"
body object Optional additionalProperties: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000",
    "skill_id": "default-tagging-skill"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate Threat Signals article AI tags — cloudflare.rssarticletaggenerate

Runs the default AI tagging skill on an article and replaces its AI-applied tags.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add tag to Threat Signals article — cloudflare.rssarticletagadd

Applies a tag from the account's tag catalog to a Threat Signals article.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"
body object Optional
body.tag_id string Required UUID of a tag from the account's catalog to apply to the article. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove tag from Threat Signals article — cloudflare.rssarticletagremove

Removes a tag from a Threat Signals article.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.article_id string Required Threat Signals article UUID format: "uuid"
path.tag_id string Required UUID of a tag from the account's catalog format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "article_id": "00000000-0000-4000-8000-000000000000",
    "tag_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Threat Signals feed categories — cloudflare.rssfeedcategorylist

Lists the predefined categories that can be assigned to feeds.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Threat Signals feeds — cloudflare.rssfeedlist

Lists the account's Threat Signals feed subscriptions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional 1-based page number. Minimum 1; defaults to 1. default: 1; minimum: 1
query.per_page integer Optional Number of feeds per page, from 1 to 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.limit integer Optional Optional 1–100 alias for per_page. When provided, limit takes precedence. minimum: 1; maximum: 100
query.sort string Optional Sort by created_at, title, category, or url. Prefix the field with - for descending order; defaults to -created_at. default: "-created_at"; pattern: "^-?(created_at|title|category|url)$"
query.category string Optional Exact feed-category filter, up to 100 characters. Omit to include all categories. maxLength: 100
query.source_type string Optional Filter by curated or custom feed source. Omit to include both source types. enum: ["curated","custom"]
query.enabled boolean Optional Filter by enabled state. Accepts true, false, 1, or 0; omit to include enabled and disabled feeds.
query.status string Optional Exact stored polling-status filter, such as active or error. Omit to include every status.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Threat Signals feed — cloudflare.rssfeedcreate

Subscribes the account to a custom or curated Threat Signals feed. Adding a custom feed when the account is at its custom-feed limit returns 403 with errors[0].reason threat_signals_feed_limit, and errors[0].custom_feed_limit and errors[0].custom_feed_count give the limit and current count. Curated feeds are not subject to this limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.category_id string | null Optional One of the predefined Threat Signals feed categories; see GET /:account_id/v2/threat-signals/categories. enum: ["b12a0fd6-f7b9-5393-9ef3-f888d506c550","d5b70eaa-626f-5761-b55b-6d9590df49fb","3b572d2b-890d-5286-9433-f18c85079030","17f90d3b-37d3-5241-8ad4-7d6abbc2006c","c68f28e9-7e8f-5d4b-853b-f3076893a9ee","bb0e4a94-38ab-5c14-80a7-28cee9f4b139","b1ef66d9-a73c-58dc-b269-22d34dfd11f4","ab02a976-0a20-5c76-a553-7f6325afacfe"]
body.curated_feed_id string Optional UUID of a curated feed to subscribe to. Provide exactly one of url or curated_feed_id. The account must have feed creation entitlement and not exceed feed allowance. format: "uuid"
body.display_name string | null Optional Override the feed's display name. Null clears it; omit to keep existing or derived value. maxLength: 255
body.enabled boolean Optional Whether to actively poll the feed. Default true. default: true
body.poll_interval_s integer Optional Polling interval in seconds (60-86400). Default 300s (5 minutes). default: 300; minimum: 60; maximum: 86400
body.title string | null Optional Override the feed's title. Null clears it; omit to keep existing or derived value. maxLength: 255
body.url string Optional HTTPS RSS feed URL. Provide exactly one of url or curated_feed_id. The account must have feed creation entitlement and not exceed feed allowance. maxLength: 2048; format: "uri"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger Threat Signals feed poll — cloudflare.rssfeedpoll

Starts an immediate poll of one or all Threat Signals feeds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.feed_id — Optional UUID of a specific feed to poll, or "all" to poll all feeds. Omit or pass "all" for all feeds.
query.feed_id string Optional anyOf[1]; format: "uuid"
query.feed_id string Optional anyOf[2]; enum: ["all"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Threat Signals feed — cloudflare.rssfeeddelete

Unsubscribes the account from a Threat Signals feed and deletes its articles.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.feed_id string Required UUID of the Threat Signals feed format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "feed_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Threat Signals feed — cloudflare.rssfeedupdate

Updates a Threat Signals feed subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.feed_id string Required UUID of the Threat Signals feed format: "uuid"
body object Optional
body.category_id string | null Optional One of the predefined Threat Signals feed categories; see GET /:account_id/v2/threat-signals/categories. enum: ["b12a0fd6-f7b9-5393-9ef3-f888d506c550","d5b70eaa-626f-5761-b55b-6d9590df49fb","3b572d2b-890d-5286-9433-f18c85079030","17f90d3b-37d3-5241-8ad4-7d6abbc2006c","c68f28e9-7e8f-5d4b-853b-f3076893a9ee","bb0e4a94-38ab-5c14-80a7-28cee9f4b139","b1ef66d9-a73c-58dc-b269-22d34dfd11f4","ab02a976-0a20-5c76-a553-7f6325afacfe"]
body.display_name string | null Optional Override the feed's display name. Null clears it; omit to keep existing or derived value. maxLength: 255
body.enabled boolean Optional Whether to actively poll the feed. Omit to keep current value.
body.poll_interval_s integer Optional New polling interval in seconds (60-86400). Omit to keep current value. minimum: 60; maximum: 86400
body.title string | null Optional Override the feed's title. Null clears it; omit to keep existing or derived value. maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "feed_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Threat Signals feed XML — cloudflare.rssfeedrawget

Retrieves the feed document fetched by the most recent poll as text/plain by default or application/xml when format is xml.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.feed_id string Required UUID of the Threat Signals feed format: "uuid"
query object Optional additionalProperties: false
query.format string Optional Response format. Use xml for application/xml; omit it for the default text/plain response. enum: ["xml"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "feed_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Threat Signals feed skills — cloudflare.rssfeedskillsget

Retrieves active non-IOC-context Managed Default Skills followed by active Custom Skills assigned to the feed, with each entry's source. Free Threat Signals accounts receive only those Managed Default Skills.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.feed_id string Required UUID of the Threat Signals feed format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "feed_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Threat Signals feed skills — cloudflare.rssfeedskillsset

Replaces the ordered custom skills assigned to a Threat Signals feed. Requires a paid Threat Signals subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.feed_id string Required UUID of the Threat Signals feed format: "uuid"
body object Optional
body.skill_ids array Required Ordered array of Custom Skill UUIDs (max 20). Replaces the feed's custom skill assignments. Free accounts cannot assign custom skills. Managed default skills are unaffected. maxItems: 20; uniqueItems: true
body.skill_ids[] string Optional format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "feed_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Threat Signals article indicators — cloudflare.rssarticleindicatorlist

Lists indicators of compromise extracted from the account's Threat Signals articles.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.feed_id string Optional Feed UUID filter. Omit to include indicators from every account feed. format: "uuid"
query.article_id string Optional Article UUID filter. Omit to include indicators from every article. format: "uuid"
query.search string Optional NFC-normalized and trimmed, case-insensitive literal substring search of indicator values. Requires 3–500 Unicode code points; the upper code-point bound is described here because OpenAPI string length cannot precisely express it without imposing UTF-16 semantics.
query.per_page integer Optional Number of indicators per cursor page, from 1 to 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.sort string Optional Sort by id. Use id for ascending or -id for descending order; defaults to id. default: "id"; pattern: "^-?(id)$"
query.include_total boolean Optional When true on the first page, count matching indicators and return an exact total. Defaults to false; cursor pages do not recalculate totals. default: false
query.cursor string Optional Opaque cursor from the previous response's pagination.cursor. When provided, page size, ordering, and filters come from the cursor. Sending per_page, sort, include_total, feed_id, article_id, or search alongside it returns a 400 CursorFilterConflictError. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search Threat Signals articles using AI Search — cloudflare.searchthreatsignals

Searches the account's Threat Signals articles using keyword and semantic retrieval.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Required additionalProperties: false
query.query string Required Keyword and semantic article-search text, from 1 to 1000 characters. minLength: 1; maxLength: 1000
query.max_results — Optional Maximum search matches to request, an integer from 1 to 50. Defaults to 20 when omitted or empty; multiple matches from one article can produce fewer returned articles.
query.max_results string Optional anyOf[1]; enum: [""]
query.max_results string Optional anyOf[2]
query.feed_id string Optional Optional feed UUID that restricts results to articles from that feed. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "query": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Threat Signals skills — cloudflare.rssskilllist

Lists active Managed Default Skills and Custom Skills. Free Threat Signals accounts see active managed defaults only, with custom_skills_available: false.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional Page number (≥ 1, default 1). default: 1; minimum: 1
query.per_page integer Optional Results per page (1–100, default 20). default: 20; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Threat Signals skill — cloudflare.rssskillcreate

Creates a Custom Skill for the account. Free Threat Signals accounts cannot create Custom Skills.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Optional
body.name string Required Custom Skill name (1–100 characters). minLength: 1; maxLength: 100
body.output_schema string Required JSON Schema serialized as a string (max 4096 characters). minLength: 1; maxLength: 4096
body.prompt string Required AI prompt (1–4000 characters) defining the skill's instructions. minLength: 1; maxLength: 4000
body.type string Optional Optional label; does not affect execution. Defaults to "summary". enum: ["summary","tags"]; default: "summary"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Threat Signals skill — cloudflare.rssskilldelete

Deletes a Custom Skill. The skill's stored outputs on articles are deleted with it. Managed Default Skills cannot be deleted. Free Threat Signals accounts cannot delete Custom Skills.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.skill_id string Required Custom Skill UUID or a Managed Default Skill ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "skill_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Threat Signals skill — cloudflare.rssskillget

Retrieves a Managed Default Skill or Custom Skill. Managed catalog definitions are readable. Free Threat Signals accounts cannot read Custom Skills.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.skill_id string Required Custom Skill UUID or a Managed Default Skill ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "skill_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Threat Signals skill — cloudflare.rssskillupdate

Updates a Custom Skill. Managed Default Skills cannot be updated. Free Threat Signals accounts cannot update Custom Skills.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.skill_id string Required Custom Skill UUID or a Managed Default Skill ID
body object Optional
body.config string Optional Optional skill configuration (stored but not currently interpreted).
body.is_active boolean Optional Whether the skill is active and eligible for feed assignment.
body.name string Optional Custom Skill name (1–100 characters). minLength: 1; maxLength: 100
body.output_schema string Optional JSON Schema serialized as a string (max 4096 characters). minLength: 1; maxLength: 4096
body.prompt string Optional AI prompt (1–4000 characters) defining the skill's instructions. minLength: 1; maxLength: 4000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "skill_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Threat Signals skill tag categories — cloudflare.rssskilltagcategoriesget

Retrieves the Tag Categories the managed default tagging skill may select tags from. This configures the managed default tagging skill, not Custom Skills.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.skill_id string Required Must be default-tagging-skill; configures the managed default tagging skill enum: ["default-tagging-skill"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "skill_id": "default-tagging-skill"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Threat Signals skill tag categories — cloudflare.rssskilltagcategoriesreplace

Replaces the Tag Categories the managed default tagging skill may select tags from. This configures the managed default tagging skill, not Custom Skills.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.skill_id string Required Must be default-tagging-skill; configures the managed default tagging skill enum: ["default-tagging-skill"]
body object Optional
body.category_uuids array Required Up to 100 unique tag category UUIDs that the managed default tagging skill may select tags from. maxItems: 100; uniqueItems: true
body.category_uuids[] string Optional format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "skill_id": "default-tagging-skill"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List existing CNI objects — cloudflare.list_cnis

Lists all Cloud Network Interconnects (CNIs) configured for the account, showing connection status and parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.slot string | null Optional If specified, only show CNIs associated with the specified slot
query.tunnel_id string | null Optional If specified, only show cnis associated with the specified tunnel id
query.cursor integer | null Optional
query.limit integer | null Optional minimum: 0
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new CNI object — cloudflare.create_cni

Creates a new Cloud Network Interconnect (CNI) for private network connectivity between Cloudflare and your infrastructure. CNIs enable dedicated, high-performance network links.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"
body — Required $ref: "#/definitions/nsc_CniCreate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "interconnect": "example",
    "account": "example",
    "magic": {
      "conduit_name": "example",
      "description": "example",
      "mtu": 1
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a specified CNI object — cloudflare.delete_cni

Permanently removes a Cloud Network Interconnect (CNI) configuration. The private network connection will be terminated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cni string Required CNI ID to retrieve information about format: "uuid"
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cni": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get information about a CNI object — cloudflare.get_cni

Retrieves configuration details for a specific Cloud Network Interconnect (CNI), including connection status and parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cni string Required CNI ID to retrieve information about format: "uuid"
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cni": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Modify stored information about a CNI object — cloudflare.update_cni

Updates the configuration of an existing Cloud Network Interconnect (CNI), including connection parameters and routing settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cni string Required CNI ID to retrieve information about format: "uuid"
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"
body — Required $ref: "#/definitions/nsc_Cni"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cni": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  },
  "body": {
    "id": "00000000-0000-4000-8000-000000000000",
    "interconnect": "example",
    "account": "example",
    "p2p_ip": "192.168.3.4/31",
    "cust_ip": "192.168.3.4/31",
    "magic": {
      "conduit_name": "example",
      "description": "example",
      "mtu": 1
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List existing interconnects — cloudflare.list_interconnects

Lists all network interconnects configured for the account, including physical and virtual connections.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.site string | null Optional If specified, only show interconnects located at the given site
query.type string | null Optional If specified, only show interconnects of the given type
query.cursor integer | null Optional
query.limit integer | null Optional minimum: 0
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new interconnect — cloudflare.create_interconnect

Creates a new network interconnect for connecting Cloudflare's network to external networks. Interconnects provide dedicated bandwidth and reduced latency for traffic exchange.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"
body — Required $ref: "#/definitions/nsc_InterconnectCreate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "type": "example",
    "account": "example",
    "slot_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an interconnect object — cloudflare.delete_interconnect

Permanently removes a network interconnect configuration. The physical or virtual connection will be terminated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.icon string Required Interconnect name to retrieve information about
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "icon": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get information about an interconnect object — cloudflare.get_interconnect

Retrieves configuration and status details for a specific network interconnect.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.icon string Required Interconnect name to retrieve information about
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "icon": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate the Letter of Authorization (LOA) for a given interconnect — cloudflare.get_interconnect_loa

Downloads the Letter of Authorization (LOA) for a network interconnect, required for physical cross-connect provisioning.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.icon string Required Interconnect name to retrieve information about
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"
query object Optional additionalProperties: false
query.name string | null Optional Custom name to use in the LOA instead of the account name (200 Character limit)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "icon": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the default customer name for LOA generation — cloudflare.get_interconnect_loa_default_name

Retrieves the default customer name that will be used in the LOA if no name is provided to the /accounts/{account_id}/cni/interconnects/{icon}/loa endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.icon string Required Interconnect name to retrieve information about
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "icon": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the current status of an interconnect object — cloudflare.get_interconnect_status

Gets the current operational status of a network interconnect, including link state and traffic metrics.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.icon string Required Interconnect name to retrieve information about
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "icon": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the current settings for the active account — cloudflare.get_settings

Retrieves current settings configuration for the specified resource or service.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account tag to retrieve settings for

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the current settings for the active account — cloudflare.update_settings

Updates configuration settings for the specified resource or service.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account tag to update settings for
body — Required $ref: "#/definitions/nsc_SettingsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a list of all slots matching the specified parameters — cloudflare.list_slots

Lists all available infrastructure slots for the account, showing allocation status and capacity.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.address_contains string | null Optional If specified, only show slots with the given text in their address field
query.site string | null Optional If specified, only show slots located at the given site
query.speed string | null Optional If specified, only show slots that support the given speed
query.occupied boolean | null Optional If specified, only show slots with a specific occupied/unoccupied state
query.cursor integer | null Optional
query.limit integer | null Optional minimum: 0
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get information about the specified slot — cloudflare.get_slot

Gets information about a specific infrastructure slot allocation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.slot string Required format: "uuid"
path.account_id — Required $ref: "#/definitions/nsc_AccountTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "slot": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Workers VPC connectivity services — cloudflare.connectivity-services-list

Lists the Workers VPC connectivity services in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
query object Optional additionalProperties: false
query.type string | null Optional
query.type — Optional oneOf[1]; $ref: "#/definitions/infra_ServiceType"
query.page integer Optional Current page in the response default: 1; minimum: 1
query.per_page integer Optional Max amount of entries returned per page default: 1000; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Workers VPC connectivity service — cloudflare.connectivity-services-delete

Removes a single Workers VPC connectivity service by its ID. Any Worker bindings referencing this service will stop working.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.service_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "service_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers VPC connectivity service — cloudflare.connectivity-services-get

Fetches a single Workers VPC connectivity service by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.service_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "service_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Applications associated with your account — cloudflare.listapplications

Lists all the applications that are associated with your account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
query object Optional additionalProperties: false
query.per_page integer Optional Maximum number of applications to return per page. Defaults to all, or 100 when page_token is set. minimum: 1; maximum: 500
query.page_token string Optional Opaque token from a previous response to retrieve the next page.
query.name — Optional Filter applications by name. $ref: "#/definitions/cc_ApplicationName"
query.image — Optional Filter applications by image. $ref: "#/definitions/cc_Image"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new application — cloudflare.createapplication

Create a Containers application.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
body — Required $ref: "#/definitions/cc_ContainersCreateApplicationRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "body": {
    "name": "example",
    "scheduling_policy": "default",
    "instances": 1,
    "max_instances": 1,
    "configuration": {
      "image": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single application by id — cloudflare.deleteapplication

Deletes a single application by id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.application_id — Required $ref: "#/definitions/cc_ApplicationID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "application_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a single application by id — cloudflare.getapplication

Returns a single application by id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.application_id — Required $ref: "#/definitions/cc_ApplicationID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "application_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Modify an application — cloudflare.modifyapplication

Modifies a single application by id. Durable Object-managed application settings are published to runtime metadata without creating deployments or rollouts. Top-level observability for these applications supports only logs.enabled. The supported fields depend on the existing application's scheduling policy. For scheduler-backed applications, changes that replace instance deployment configuration, including the image, require a rollout.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.application_id — Required $ref: "#/definitions/cc_ApplicationID"
body — Required $ref: "#/definitions/cc_ContainersModifyApplicationRequestBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "application_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List container instances — cloudflare.listcontainerinstances_v2

Lists container instances belonging to an application.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.application_id — Required $ref: "#/definitions/cc_ApplicationID"
query object Optional additionalProperties: false
query.per_page integer Optional Maximum number of instances to return per page. Defaults to 100. minimum: 1; maximum: 1000
query.page_token string Optional Opaque token from a previous response to retrieve the next page.
query.state string Optional Filters instances by lifecycle state. active includes provisioning, running, and stopping instances; not-active includes stopped and failed instances. When omitted, all instances are returned. enum: ["active","not-active"]
query.name_prefix string Optional Filter instances by a case-sensitive name prefix, falling back to the actor ID when no name is known. Keep the same prefix when using a page token.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "application_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new rollout for an application — cloudflare.createapplicationrollout

Creates a rollout to update the application's configuration across instances with minimal downtime. Rollouts apply only to scheduler-backed applications with scheduling_policy: "default". Versions and rollouts do not apply to applications with scheduling_policy: "durable_object".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.application_id — Required $ref: "#/definitions/cc_ApplicationID"
body — Required $ref: "#/definitions/cc_ContainersCreateApplicationRolloutRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "application_id": "example"
  },
  "body": {
    "target_configuration": {},
    "strategy": "rolling",
    "description": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all application versions — cloudflare.listapplicationversions

Returns all versions for a scheduler-backed application with scheduling_policy: "default". Versions and rollouts do not apply to applications with scheduling_policy: "durable_object".

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.application_id — Required $ref: "#/definitions/cc_ApplicationID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "application_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Prepare a container image — cloudflare.preparecontainerimage

Idempotently starts or observes preparation of the runtime artifacts required to run one digest-pinned managed container image on Cloudflare's network. Returns 202 while durable preparation continues and 200 when the image is ready or preparation has reached a terminal error.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
body — Required $ref: "#/definitions/cc_PrepareContainerImageRequestBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "body": {
    "image": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the list of configured registries in the account — cloudflare.listimageregistries

Get the list of configured registries in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Configure a private external image registry — cloudflare.createimageregistry

Registers credentials for a supported private external image registry so Containers can pull images from it. This endpoint does not create a registry or upload an image. Public Docker Hub images and images in the Cloudflare managed registry do not require this configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
body — Required $ref: "#/definitions/cc_ContainersCreateImageRegistryRequestBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123"
  },
  "body": {
    "domain": "docker.io",
    "auth": {
      "public_credential": "example-user",
      "private_credential": {
        "store_id": "14758f1afd44c09b7992073ccf00b43d",
        "secret_name": "API_KEY"
      }
    },
    "kind": "ECR"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a registry from the account — cloudflare.deleteimageregistry

Delete a registry from the account, this will prevent Containers from pulling images from the registry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.domain string Required The domain to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "domain": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate a JWT to interact with the specified image registry. — cloudflare.generateimageregistrycredentials

Generates credentials for accessing a configured container image registry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier.
path.domain string Required The domain to get credentials for.
body — Required $ref: "#/definitions/cc_ImageRegistryCredentialsConfiguration"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "account-123",
    "domain": "registry.cloudflare.com"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Custom CSRs — cloudflare.custom-csrs-for-an-account-list-custom-csrs

List all custom Certificate Signing Requests (CSRs) for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of custom CSRs per page. default: 50; minimum: 5; maximum: 50
query.order string Optional The field to sort the returned custom CSRs by. enum: ["name","account_tag","created_at"]; default: "created_at"
query.direction string Optional The direction to sort by. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Custom CSR — cloudflare.custom-csrs-for-an-account-create-custom-csr

Generate a new custom Certificate Signing Request (CSR) for an account. Cloudflare generates and securely stores the private key associated with the CSR.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_create_request-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "country": "US",
    "state": "California",
    "locality": "San Francisco",
    "organization": "Cloudflare, Inc.",
    "common_name": "example.com",
    "sans": [
      "example.com",
      "www.example.com"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Custom CSR — cloudflare.custom-csrs-for-an-account-delete-custom-csr

Delete a custom Certificate Signing Request (CSR) and its associated private key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_csr_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_identifier"
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Custom CSR Details — cloudflare.custom-csrs-for-an-account-custom-csr-details

Retrieve details for a specific custom Certificate Signing Request (CSR).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_csr_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_identifier"
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Account Custom Nameservers — cloudflare.account-level-custom-nameservers-list-account-custom-nameservers

List an account's custom nameservers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-custom-nameservers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "372e67954025e0ba6aaa6d586b9e0b59"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Account Custom Nameserver — cloudflare.account-level-custom-nameservers-add-account-custom-nameserver

Adds a custom nameserver to the account for use as a vanity nameserver on zones.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-custom-nameservers_identifier"
body — Required $ref: "#/definitions/dns-custom-nameservers_CustomNSInput"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "372e67954025e0ba6aaa6d586b9e0b59"
  },
  "body": {
    "ns_name": "ns1.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Account Custom Nameserver — cloudflare.account-level-custom-nameservers-delete-account-custom-nameserver

Removes a custom nameserver from the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_ns_id — Required $ref: "#/definitions/dns-custom-nameservers_ns_name"
path.account_id — Required $ref: "#/definitions/dns-custom-nameservers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_ns_id": "ns1.example.com",
    "account_id": "372e67954025e0ba6aaa6d586b9e0b59"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom pages — cloudflare.custom-pages-for-an-account-list-custom-pages

Lists all custom page configurations for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom assets — cloudflare.custom-assets-for-an-account-list-custom-assets

Lists custom assets for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of custom assets per page. default: 20; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom asset — cloudflare.custom-assets-for-an-account-create-a-custom-asset

Creates a custom asset for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"
body object Required
body.description — Required $ref: "#/definitions/custom-pages_asset_description"
body.name — Required $ref: "#/definitions/custom-pages_asset_name"
body.url — Required $ref: "#/definitions/custom-pages_asset_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "my_custom_error_page",
    "description": "Custom 500 error page",
    "url": "https://example.com/error.html"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom asset — cloudflare.custom-assets-for-an-account-delete-a-custom-asset

Deletes a custom asset from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asset_name — Required $ref: "#/definitions/custom-pages_asset_name"
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asset_name": "my_custom_error_page",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom asset — cloudflare.custom-assets-for-an-account-get-a-custom-asset

Returns a custom asset for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asset_name — Required $ref: "#/definitions/custom-pages_asset_name"
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asset_name": "my_custom_error_page",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom asset — cloudflare.custom-assets-for-an-account-update-a-custom-asset

Updates a custom asset for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asset_name — Required $ref: "#/definitions/custom-pages_asset_name"
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"
body object Required
body.description — Required $ref: "#/definitions/custom-pages_asset_description"
body.url — Required $ref: "#/definitions/custom-pages_asset_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asset_name": "my_custom_error_page",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "description": "Custom 500 error page",
    "url": "https://example.com/error.html"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a preview token — cloudflare.custom-pages-for-an-account-create-preview-token

Creates a signed JWT for previewing an account-level custom page before it is published.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"
body — Required $ref: "#/definitions/custom-pages_preview_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "act": "preview",
    "target": "block:waf",
    "url": "https://example.com/error.html"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom page — cloudflare.custom-pages-for-an-account-get-a-custom-page

Returns the configuration for a custom page type at the account level.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/custom-pages_error_page_type"
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ratelimit_block",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom page — cloudflare.custom-pages-for-an-account-update-a-custom-page

Updates the configuration for a custom page type at the account level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/custom-pages_error_page_type"
path.account_id — Required Identifier of the Cloudflare account. $ref: "#/definitions/custom-pages_identifier"
body object Required
body.state — Required $ref: "#/definitions/custom-pages_state"
body.url — Required $ref: "#/definitions/custom-pages_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ratelimit_block",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "url": "http://www.example.com",
    "state": "default"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List D1 Databases — cloudflare.d1-list-databases

List D1 databases in your account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
query object Optional additionalProperties: false
query.name string Optional a database name to search for.
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of items per page. default: 1000; minimum: 10; maximum: 10000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create D1 Database — cloudflare.d1-create-database

Create a new D1 database in your account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
body object Required
body.jurisdiction — Optional $ref: "#/definitions/d1_jurisdiction"
body.name — Required $ref: "#/definitions/d1_database-name"
body.primary_location_hint — Optional $ref: "#/definitions/d1_primary-location-hint"
body.read_replication — Optional $ref: "#/definitions/d1_read-replication-details-for-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "my-database"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete D1 Database — cloudflare.d1-delete-database

Delete a D1 database.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update D1 Database partially — cloudflare.d1-update-partial-database

Partially update a D1 database's configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
body — Required $ref: "#/definitions/d1_database-update-partial-request-body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update D1 Database — cloudflare.d1-update-database

Update a D1 database's configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
body — Required $ref: "#/definitions/d1_database-update-request-body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "body": {
    "read_replication": {
      "mode": "auto"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export D1 Database as SQL — cloudflare.d1-export-database

Export the SQL contents of a D1 database and return a URL where they can be downloaded. Note: this process may take some time for larger DBs, during which your D1 will be unavailable to serve queries. To avoid blocking your DB unnecessarily, an in-progress export must be continually polled or will automatically cancel.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
body object Required
body.current_bookmark string Optional To poll an in-progress export, provide the current bookmark (returned by your first polling response)
body.dump_options object Optional
body.dump_options.no_data boolean Optional Export only the table definitions, not their contents
body.dump_options.no_schema boolean Optional Export only each table's contents, not its definition
body.dump_options.tables array Optional Filter the export to just one or more tables. Passing an empty array is the same as not passing anything and means: export all tables.
body.dump_options.tables[] string Optional
body.output_format string Required Specifies that you will poll this endpoint until the export completes enum: ["polling"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "body": {
    "output_format": "polling"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Import SQL into your D1 Database — cloudflare.d1-import-database

Generate a temporary URL for uploading an SQL file to, then instruct the D1 to import it and poll it for status updates. Imports block the D1 for their duration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
body — Required
body object Required init oneOf[1]
body.action string Required Indicates you have a new SQL file to upload. oneOf[1]; enum: ["init"]
body.etag string Required Required when action is 'init' or 'ingest'. An md5 hash of the file you're uploading. Used to check if it already exists, and validate its contents before ingesting. oneOf[1]
body object Required ingest oneOf[2]
body.action string Required Indicates you've finished uploading to tell the D1 to start consuming it oneOf[2]; enum: ["ingest"]
body.etag string Required An md5 hash of the file you're uploading. Used to check if it already exists, and validate its contents before ingesting. oneOf[2]
body.filename string Required The filename you have successfully uploaded. oneOf[2]
body object Required poll oneOf[3]
body.action string Required Indicates you've finished uploading to tell the D1 to start consuming it oneOf[3]; enum: ["poll"]
body.current_bookmark string Required This identifies the currently-running import, checking its status. oneOf[3]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "body": {
    "action": "init",
    "etag": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query D1 Database — cloudflare.d1-query-database

Execute a SQL query against a D1 database and return results as objects.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
body — Required $ref: "#/definitions/d1_batch-query"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "body": {
    "sql": "SELECT * FROM myTable WHERE field = ? OR field = ?;"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Raw D1 Database query — cloudflare.d1-raw-database-query

Execute a SQL query against a D1 database and return result rows as arrays rather than objects. This is a performance-optimized version of the /query endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
body — Required $ref: "#/definitions/d1_batch-query"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "body": {
    "sql": "SELECT * FROM myTable WHERE field = ? OR field = ?;"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get D1 database bookmark — cloudflare.d1-time-travel-get-bookmark

Retrieve the current bookmark, or the nearest bookmark at or before a provided timestamp. Bookmarks can be used with the restore endpoint to revert the database to a previous point in time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
query object Optional additionalProperties: false
query.timestamp — Optional An optional ISO 8601 timestamp. If provided, returns the nearest available bookmark at or before this timestamp. If omitted, returns the current bookmark. $ref: "#/definitions/d1_time-travel-timestamp"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore D1 Database to a bookmark or point in time — cloudflare.d1-time-travel-restore

Restore a D1 database to a previous point in time either via a bookmark or a timestamp.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
query object Optional additionalProperties: false
query.bookmark — Optional A bookmark to restore the database to. Required if timestamp is not provided. $ref: "#/definitions/d1_time-travel-bookmark"
query.timestamp — Optional An ISO 8601 timestamp to restore the database to. Required if bookmark is not provided. $ref: "#/definitions/d1_time-travel-timestamp"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Undelete D1 Database — cloudflare.d1-undelete-database

Restore a deleted D1 database. The database is restored with the name it had when it was deleted, unless new_name is provided. The restored database counts against the account's limits. Undeleting a database that is not deleted succeeds without changes, unless new_name differs from its current name which errors. A database can only be undeleted within 7 days (7 24 hours) of its deletion.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/d1_account-identifier"
path.database_id — Required $ref: "#/definitions/d1_database-identifier"
body object Optional additionalProperties: false
body.new_name — Optional Restore the database with this name instead of the name it had when it was deleted. Required if another database in the account already uses that name.
body.new_name — Optional allOf[1]; $ref: "#/definitions/d1_database-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List asset schemas — cloudflare.listassetschemas

Returns the catalog of asset classes available when authoring custom findings, grouped by vendor. Optionally filter to a single vendor with the vendor query parameter.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.vendor string Optional Restrict the result to a single vendor. Unknown values return 400. enum: ["ANTHROPIC","AWS","BITBUCKET","BOX","CONFLUENCE","DROPBOX","GITHUB","GOOGLE_CLOUD_PLATFORM","GOOGLE_WORKSPACE","JIRA","MICROSOFT","OPENAI","SALESFORCE","SERVICENOW","SLACK","WORKDAY","ZOOM"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get asset schema by asset class — cloudflare.getassetschema

Returns the fields and related attributes a custom finding type may reference for the given asset class (JSON Schema). Used by the custom finding types builder.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.asset_class string Required Asset class identifier (PascalCase), e.g. AnthropicApiKey.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "asset_class": "AnthropicApiKey"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DLP content findings — cloudflare.listcontentassets

List DLP content findings

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.dlp_profile_id string Optional Filter by an DLP profile ID format: "uuid"
query.integration_id string Optional Filter by an integration ID format: "uuid"
query.max_affliction_date string Optional Filter to view findings that occurred on or before the affliction date. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.min_affliction_date string Optional Filter to view findings that occurred on or after the affliction date. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.order string Optional Which field to use when ordering content assets. enum: ["asset_name","dlp_profile_count","integration_name","latest_affliction_date"]
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.
query.search string Optional A search term.
query.vendor — Optional Filter by vendor $ref: "#/definitions/posture-api_VendorsEnum"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a content export — cloudflare.createcontentexport

Creates a CSV export for content and accepts optional filters in the payload.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Optional $ref: "#/definitions/posture-api_ContentExportRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all export jobs — cloudflare.listexportjobs

List all export jobs for a given requestor's organization

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.
query.status — Optional Filter on export job's status $ref: "#/definitions/posture-api_StatusEnum"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all finding types — cloudflare.listfindingtypes

List all available finding types with pagination support.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.
query.vendors array Optional Filter finding types by vendor. Supports multiple comma-separated values. Each value may be either the vendor enum (GOOGLE_WORKSPACE) or the friendly name returned by the read routes (Google Workspace).
query.vendors[] — Optional $ref: "#/definitions/posture-api_FindingTypeVendorsEnum"
query.types array Optional Filter finding types by category type. Supports multiple comma-separated, case-insensitive values.
query.types[] — Optional $ref: "#/definitions/posture-api_FindingCategoryTypeEnum"
query.origins array Optional Filter finding types by origin. Supports multiple comma-separated, case-insensitive values.
query.origins[] — Optional $ref: "#/definitions/posture-api_FindingTypeOriginEnum"
query.severities array Optional Filter finding types by severity. Supports multiple comma-separated, case-insensitive values.
query.severities[] — Optional $ref: "#/definitions/posture-api_FindingTypeSeverityEnum"
query.search string Optional Filter finding types by name or ID (case-insensitive substring match).
query.quarantined boolean Optional When true, return only quarantined finding types; when false, return only non-quarantined finding types. Omit to return both.
query.min_updated_at string Optional Return only finding types updated at or after this RFC 3339 timestamp (inclusive). format: "date-time"
query.max_updated_at string Optional Return only finding types updated at or before this RFC 3339 timestamp (inclusive). format: "date-time"
query.order string Optional Field to sort by (case-insensitive). Defaults to 'created'. Name and vendor sorting is case-insensitive; vendor uses friendly provider names. Ascending order: type Content then Posture; origin custom then system; severity Low, Medium, High, Critical. enum: ["created","updated","match_count","name","vendor","type","origin","severity"]
query.direction string Optional Sort direction for the primary field. Defaults to 'desc'. Ties are resolved by case-insensitive name, then ID, both ascending regardless of direction. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom finding type — cloudflare.createfindingtype

Create a new custom finding type with policy definition.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Required $ref: "#/definitions/posture-api_create-finding-type-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  },
  "body": {
    "name": "Excessive File Sharing",
    "description": "Detects files shared with too many users",
    "asset_vendor": "GOOGLE_WORKSPACE",
    "asset_class": "GoogleWorkspaceFile",
    "severity": "High",
    "expression": "default result := \"pass\"\n\nresult := \"fail\" if input.asset.publicLinkDisabled == false\n",
    "applies_to_all_integrations": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate a custom finding type — cloudflare.validatefindingtype

Check a candidate custom finding type without creating it, so problems can be corrected before publishing. The request body is the same shape as CreateFindingType, and the candidate is checked against the same rules, so a valid result means the definition itself is sound. It is not a reservation: a create can still be rejected for a reason that does not belong to the definition, such as the account already holding the maximum number of custom finding types.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Required $ref: "#/definitions/posture-api_create-finding-type-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  },
  "body": {
    "name": "Excessive File Sharing",
    "description": "Detects files shared with too many users",
    "asset_vendor": "GOOGLE_WORKSPACE",
    "asset_class": "GoogleWorkspaceFile",
    "severity": "High",
    "expression": "default result := \"pass\"\n\nresult := \"fail\" if input.asset.publicLinkDisabled == false\n",
    "applies_to_all_integrations": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom finding type — cloudflare.deletefindingtype

Delete an existing custom finding type.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_type_id string Required A UUID string identifying the finding type. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_type_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get finding by ID — cloudflare.getfindingtype

Retrieve a specific finding type by its unique identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_type_id string Required A UUID string identifying the finding type. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_type_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom finding type — cloudflare.updatefindingtype

Update an existing custom finding type.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_type_id string Required A UUID string identifying the finding type. format: "uuid"
body — Required $ref: "#/definitions/posture-api_update-finding-type-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_type_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "applies_to_all_integrations": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List remediation types for a finding type — cloudflare.getremediationtypesforfindingtype

List all remediation types for a given finding type. This endpoint supports both cursor and offset pagination. Note that cursor and page are mutually exclusive.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_type_id string Required A UUID string identifying the finding type. format: "uuid"
query object Optional additionalProperties: false
query.integration_id string Optional Filter by an integration ID format: "uuid"
query.cursor string Optional A cursor for pagination.
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_type_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List posture findings — cloudflare.listfindings

List all security findings that have been identified as being problematic. This will return a list of findings regardless if they have been ignored or not.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.cursor string Optional A cursor for pagination. Obtained from the result_info.cursor field of a previous response.
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.ignored boolean Optional Filter for only the ignored findings. Set to false to only see "active" items
query.integration_id string Optional Filter by an integration ID format: "uuid"
query.max_affliction_date string Optional Filter to view findings that occurred on or before the affliction date. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.min_affliction_date string Optional Filter to view findings that occurred on or after the affliction date. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.observation string Optional Filter by observation type of the finding enum: ["Activity","Insight","Issue"]
query.order string Optional Which field to use when ordering the findings. enum: ["finding.name","instance_count","integration.name","latest_affliction_date","severity"]
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.
query.product string Optional Filter by product category of the finding enum: ["Cloud","Saas"]
query.search string Optional A search term.
query.severity string Optional Filter by severity enum: ["Critical","High","Medium","Low"]
query.type string Optional Filter by type of the finding enum: ["Content","Posture"]
query.vendor — Optional Filter by vendor $ref: "#/definitions/posture-api_VendorsEnum"
query.finding_type_ids string Optional A comma separated list of UUIDs identifying the finding type(s). format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new findings export request — cloudflare.createfindingexportcsv

Creates a CSV export for findings and accepts optional filters in the payload.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Optional $ref: "#/definitions/posture-api_FindingExportFilterRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mark a finding as ignored — cloudflare.ignorefinding

Given a list of findings, mark as ignored. Does nothing if Finding is already ignored.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Required $ref: "#/definitions/posture-api_FindingBulkActionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  },
  "body": {
    "checks": [
      "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAxOjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMgo="
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove ignore marker from a finding — cloudflare.unignorefinding

Ability to un-ignore a Finding if it's previously been ignored. Does nothing if the Finding is not ignored.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Required $ref: "#/definitions/posture-api_FindingBulkActionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  },
  "body": {
    "checks": [
      "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAxOjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMgo="
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a posture finding — cloudflare.getfinding

Gets a security Finding that has been identified as being problematic.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_id string Required The id of a finding, as returned in each item of the List posture findings response. It is a base64-encoded identifier. format: "byte"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_id": "aGVsbG8="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List instances of a finding — cloudflare.listfindinginstances

Lists all security finding instances for a given security finding.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_id string Required The id of a finding, as returned in each item of the List posture findings response. It is a base64-encoded identifier. format: "byte"
query object Optional additionalProperties: false
query.archived boolean Optional Archived
query.cursor string Optional A cursor for pagination. Obtained from the result_info.cursor field of a previous response.
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.max_affliction_date string Optional Filter to view findings that occurred on or before the affliction date. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.min_affliction_date string Optional Filter to view findings that occurred on or after the affliction date. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.order string Optional Which field to use when ordering the Finding's instances. When ordering by 'remediation.status', only the most recent non-stale remediation job is considered. Stale jobs (created before the instance's affliction_date) are treated as having no status for ordering purposes. enum: ["affliction_date","asset.name","remediation.status"]
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.
query.search string Optional A search term.
query.remediation_statuses array Optional Filter finding instances by most recent remediation job status. Supports multiple comma-separated values. Use 'none' to filter instances with no remediation jobs or instances where the most recent job is stale. Note: Stale jobs (created before the instance's affliction_date) are ignored for filtering purposes, but are still included in the 'remediations' array with stale=true.
query.remediation_statuses[] string Optional enum: ["none","pending","processing","validating","completed","failed"]
query.finding_instance_ids array Optional Filter finding instances by an array of finding instance IDs. Supports multiple comma-separated values.
query.finding_instance_ids[] string Optional format: "uuid"
query.asset_ids array Optional Filter finding instances by an array of asset IDs. Supports multiple comma-separated values.
query.asset_ids[] string Optional format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_id": "aGVsbG8="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Archive a finding — cloudflare.archivefindinginstance

Archive one or more finding instances.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_id string Required The id of a finding, as returned in each item of the List posture findings response. It is a base64-encoded identifier. format: "byte"
body — Optional $ref: "#/definitions/posture-api_FindingInstanceBulkActionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_id": "aGVsbG8="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove the archive marking from a finding instance — cloudflare.unarchivefindinginstance

Remove the archive marking from one or more finding instances.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_id string Required The id of a finding, as returned in each item of the List posture findings response. It is a base64-encoded identifier. format: "byte"
body — Optional $ref: "#/definitions/posture-api_FindingInstanceBulkActionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_id": "aGVsbG8="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a finding instance using an instance ID — cloudflare.getfindinginstance

Gets a security Finding instance by id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_id string Required The id of a finding, as returned in each item of the List posture findings response. It is a base64-encoded identifier. format: "byte"
path.instance_id string Required A uuid ID identifying this Finding instance. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_id": "aGVsbG8=",
    "instance_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset severity for a finding back to the default — cloudflare.resetfindingseverity

If a Finding's severity has been changed, reset it back to default value. Does nothing if no override exists.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_id string Required The id of a finding, as returned in each item of the List posture findings response. It is a base64-encoded identifier. format: "byte"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_id": "aGVsbG8="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the severity for a finding — cloudflare.changefindingseverity

Update the severity of a Finding. This will update the severity_override field on the Finding payload with the new severity value.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.finding_id string Required The id of a finding, as returned in each item of the List posture findings response. It is a base64-encoded identifier. format: "byte"
body — Required $ref: "#/definitions/posture-api_TuneFindingSeverityRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "finding_id": "aGVsbG8="
  },
  "body": {
    "new_severity": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a finding instances export — cloudflare.createfindinginstancesexportcsv

Creates a CSV export for Finding instances and accepts optional filters in the payload.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.storage_namespace_id string Required Identifies the finding whose instances to export, in the form &lt;integration_id&gt;-&lt;finding_type_id&gt;. Take integration.id and finding.id from the finding in the List posture findings response and join them with a hyphen. pattern: "^[\\da-f]{8}-([\\da-f]{4}-){3}[\\da-f]{12}-[\\da-f]{8}-([\\da-f]{4}-){3}[\\da-f]{12}$"
body — Optional $ref: "#/definitions/posture-api_FindingInstanceExportFilterRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "storage_namespace_id": "00000000-0000-0000-0000-000000000001-00000000-0000-0000-0000-000000000002"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List policy configurations — cloudflare.listpolicies

Returns a list of integration-scoped policy configurations for the given account. This endpoint supports cursor based pagination. By default, results are returned in sorted order based on created_at.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.cursor string Optional Cursor for pagination. Obtained from the result_info.cursor field of a previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a policy configuration — cloudflare.deletepolicy

Deletes a policy configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.policy_id string Required A UUID identifying the policy. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "policy_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a policy configuration by ID — cloudflare.getpolicybyid

Retrieves the details of a specific policy configuration, including its associated remediation and webhook actions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.policy_id string Required The UUID of the policy configuration to retrieve. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "policy_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List policy invocation logs — cloudflare.listpolicylogentries

Returns a list of policy invocation logs for the given account, sourced from ClickHouse via Ready Analytics. Each entry represents one execution of a policy against a finding instance, including the actions (remediation jobs and webhooks) it dispatched.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.since string Optional Lower bound on the log entry timestamp. Accepts ISO 8601 / RFC3339 or epoch seconds. Defaults to 7 days before until. The window between since and until cannot exceed 180 days. format: "date-time"
query.until string Optional Upper bound on the log entry timestamp. Accepts ISO 8601 / RFC3339 or epoch seconds. Defaults to the current time. Must be greater than or equal to since. format: "date-time"
query.integration_id string Optional Comma-separated list of CASB integration IDs to filter by. At most 100 values, each at most 128 characters. Values outside the account's tenancy allowlist are silently ignored. When omitted, results are scoped to the full allowlist.
query.policy_name string Optional Comma-separated list of policy display names to filter by. At most 100 values, each at most 255 characters.
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List remediation jobs — cloudflare.listremediationjobs

List all remediation jobs tied to a specific Cloudflare Account. Note that cursor and page are mutually exclusive.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
query object Optional additionalProperties: false
query.cursor string Optional A cursor for pagination.
query.page integer Optional A page number within the paginated result set.
query.per_page integer Optional Number of results to return per page.
query.search string Optional A search term.
query.min_updated_at string Optional Filter to view remediations updated on or after the min updated datetime. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.max_updated_at string Optional Filter to view remediations updated on or before the max updated datetime. Can be a date-time in ISO 8601 format or an epoch timestamp. format: "date-time"
query.status — Optional Filter to view remediations with the given status. $ref: "#/definitions/posture-api_RemediationJobStatusEnum"
query.triggered_by_actor array Optional Filter remediations by what kind of actor triggered them. Supports multiple comma-separated values.
query.triggered_by_actor[] — Optional $ref: "#/definitions/posture-api_RemediationJobActorTypeEnum"
query.integration_id string Optional Filter by an integration ID format: "uuid"
query.order string Optional An optional param to sort the results by the given field. enum: ["created_at","affliction_date","integration_name","status","last_updated_at","asset_name","finding_type_name"]
query.direction string Optional Direction to order results. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates remediation jobs — cloudflare.createremediationjobs

Create one or more remediation jobs tied to a specific Cloudflare Account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Optional $ref: "#/definitions/posture-api_RemediationJobsCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a remediation jobs export — cloudflare.createremediationjobsexportcsv

Creates a CSV export for remediation jobs and accepts optional filters in the payload.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Optional $ref: "#/definitions/posture-api_RemediationJobsExportFilterRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List webhook configurations — cloudflare.listwebhooks

Retrieves all webhook configurations for the authenticated account. Returns an array of webhook configurations that can be used to send finding notifications.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new webhook configuration — cloudflare.createwebhook

Creates a new webhook configuration for sending finding notifications to external endpoints.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Required $ref: "#/definitions/posture-api_CreateWebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  },
  "body": {
    "label": "Send to Slack",
    "destination_url": "https://example.com/webhook",
    "authentication_type": "HMAC-Signing"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Test a webhook configuration before creating it — cloudflare.evaluatenewwebhook

Sends a test webhook event to the specified destination URL to verify the webhook endpoint is reachable and properly configured. This allows customers to validate their webhook configuration before creating the actual webhook resource.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Required $ref: "#/definitions/posture-api_EvaluateNewWebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  },
  "body": {
    "destination_url": "https://example.com/webhook",
    "authentication_type": "HMAC-Signing"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create webhook jobs — cloudflare.createwebhookjobs

Creates webhook jobs to send a finding instance to one or more configured webhooks.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
body — Required $ref: "#/definitions/posture-api_CreateWebhookJobsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6"
  },
  "body": {
    "webhook_ids": [
      "550e8400-e29b-41d4-a716-446655440000",
      "660e8400-e29b-41d4-a716-446655440001"
    ],
    "finding_instance_ids": [
      "770e8400-e29b-41d4-a716-446655440002",
      "660e8400-e29b-41d4-a716-446655440001"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a webhook configuration — cloudflare.deletewebhook

Soft deletes a webhook configuration by its unique identifier. The webhook will be marked as deleted and will no longer be available for use.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.webhook_id string Required A UUID identifying the webhook configuration. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "webhook_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get webhook configuration by ID — cloudflare.getwebhookconfigbyid

Retrieves a specific webhook configuration by its unique identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.webhook_id string Required A UUID identifying the webhook configuration. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "webhook_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an existing webhook configuration — cloudflare.updatewebhook

Updates an existing webhook configuration with new settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.webhook_id string Required A UUID identifying the webhook configuration. format: "uuid"
body — Required $ref: "#/definitions/posture-api_UpdateWebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "webhook_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "label": "Send to Slack",
    "destination_url": "https://example.com/webhook",
    "authentication_type": "HMAC-Signing",
    "status": "enabled"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Test an existing webhook configuration — cloudflare.evaluateexistingwebhook

Sends a test webhook event using an existing webhook configuration. This allows customers to verify their webhook endpoint is still reachable and properly configured after creating the webhook resource.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID for the user making the request.
path.webhook_id string Required A UUID identifying the webhook configuration. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "46148281d8a93d002ef242d8b0d5f9f6",
    "webhook_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List client versions — cloudflare.list-client-versions

Lists available WARP client versions for a specific target environment and release track. This endpoint is in Beta.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Required additionalProperties: false
query.target_environment string Required The target environment for the client version (e.g., windows, macos).
query.release_track string Required The release track (ga for General Availability, beta for Beta releases). enum: ["ga","beta"]
query.page integer Optional The page number to return. default: 1; minimum: 1
query.per_page integer Optional The maximum number of versions to return per page. default: 20; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "target_environment": "example",
    "release_track": "ga"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List available target environments — cloudflare.list-client-target-environments

Retrieves a list of all available target environments with their display names. This endpoint is in Beta.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deployment groups — cloudflare.list-deployment-groups

Lists all deployment groups for an account. Use deployment groups to assign target WARP client versions to specific devices. This endpoint is in Beta.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional The page number to return. default: 1; minimum: 1
query.per_page integer Optional The maximum number of deployment groups to return per page. default: 50; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create deployment group — cloudflare.create-deployment-group

Creates a new deployment group. Policy IDs must be unique across all deployment groups. This endpoint is in Beta.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/teams-devices_deployment_group_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "Engineering Ring 0",
    "version_config": [
      {
        "version": "2026.6.234.0",
        "target_environment": "windows"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete deployment group — cloudflare.delete-deployment-group

Deletes a deployment group. Associated policies no longer apply and devices stop receiving version targets. This endpoint is in Beta.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.group_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get deployment group — cloudflare.get-deployment-group

Fetches a single deployment group by its ID. This endpoint is in Beta.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.group_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update deployment group — cloudflare.update-deployment-group

Updates a deployment group. Returns 409 if any newly added policy IDs already belong to another deployment group. This endpoint is in Beta.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.group_id string Required
body — Required $ref: "#/definitions/teams-devices_deployment_group_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "group_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IP profiles — cloudflare.list-ip-profiles

Lists WARP Device IP profiles.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.page integer Optional The page number to return. default: 1; minimum: 1
query.per_page integer Optional The number of IP profiles to return per page. default: 50; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create IP profile — cloudflare.create-ip-profile

Creates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/teams-devices_ip_profile_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "IPv4 Cloudflare Source IPs",
    "subnet_id": "b70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "precedence": 100,
    "match": "identity.email == \"[email protected]\""
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete IP profile — cloudflare.delete-ip-profile

Delete a WARP Device IP profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get IP profile — cloudflare.get-ip-profile

Fetches a single WARP Device IP profile.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update IP profile — cloudflare.update-ip-profile

Updates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required
body — Required $ref: "#/definitions/teams-devices_ip_profile_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List your device managed networks — cloudflare.device-managed-networks-list-device-managed-networks

Fetches a list of managed networks for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a device managed network — cloudflare.device-managed-networks-create-device-managed-network

Creates a new device managed network.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.config — Required
body.config — Required allOf[1]; $ref: "#/definitions/teams-devices_schemas-config_request"
body.name — Required $ref: "#/definitions/teams-devices_device-managed-networks_components-schemas-name"
body.type — Required $ref: "#/definitions/teams-devices_components-schemas-type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "managed-network-1",
    "type": "tls",
    "config": {
      "sha256": "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c",
      "tls_sockaddr": "foo.bar:1234"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a device managed network — cloudflare.device-managed-networks-delete-device-managed-network

Deletes a device managed network and fetches a list of the remaining device managed networks for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.network_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "network_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get device managed network details — cloudflare.device-managed-networks-device-managed-network-details

Fetches details for a single managed network.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.network_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "network_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a device managed network — cloudflare.device-managed-networks-update-device-managed-network

Updates a configured device managed network.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.network_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.config — Optional
body.config — Optional allOf[1]; $ref: "#/definitions/teams-devices_schemas-config_request"
body.name — Optional $ref: "#/definitions/teams-devices_device-managed-networks_components-schemas-name"
body.type — Optional $ref: "#/definitions/teams-devices_components-schemas-type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "network_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate an uninstall protection override code — cloudflare.create-override-code

Generates an account-wide or device-specific uninstall protection override code.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/teams-devices_override_code_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "type": "uninstall_protection",
    "scope": "account",
    "duration_hours": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List devices — cloudflare.list-devices

Lists WARP devices.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.cursor string Optional Opaque token indicating the starting position when requesting the next set of records. A cursor value can be obtained from the result_info.cursor field in the response.
query.sort_by string Optional The device field to order results by. enum: ["name","id","client_version","last_seen_user.email","last_seen_at","active_registrations","created_at"]
query.sort_order string Optional Sort direction. enum: ["asc","desc"]
query.last_seen_user.email string Optional Filter by the last seen user's email.
query.seen_after string Optional Filter by the last_seen timestamp - returns only devices last seen after this timestamp.
query.seen_before string Optional Filter by the last_seen timestamp - returns only devices last seen before this timestamp.
query.per_page integer Optional The maximum number of devices to return in a single response.
query.search string Optional Search by device details.
query.active_registrations string Optional Include or exclude devices with active registrations. The default is "only" - return only devices with active registrations. enum: ["include","only","exclude"]
query.has_registration_type — Optional Filter by the type of active registration associated with the device. $ref: "#/definitions/teams-devices_registration_type"
query.id array Optional Filter by a one or more device IDs.
query.id[] string Optional
query.tag array Optional Filter by one or more device tags in key:value format. Devices must match all provided tags. maxItems: 10
query.tag[] string Optional
query.last_seen_registration.policy.id string Optional Filter by the ID of the device settings profile assigned to the device registration. format: "uuid"
query.include string Optional Comma-separated list of additional information that should be included in the device response. Supported values are: "last_seen_registration.policy".

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete device — cloudflare.delete-device

Deletes a WARP device.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.device_id string Required
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "device_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get device — cloudflare.get-device

Fetches a single WARP device.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.device_id string Required
path.account_id string Required
query object Optional additionalProperties: false
query.include string Optional Comma-separated list of additional information that should be included in the device response. Supported values are: "last_seen_registration.policy".

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "device_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update device — cloudflare.patch-device

Updates properties of a WARP device.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.device_id string Required
path.account_id string Required
body — Required $ref: "#/definitions/teams-devices_physical_device_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "device_id": "example",
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List device settings profiles — cloudflare.devices-list-device-settings-policies

Fetches a list of the device settings profiles for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
query object Optional additionalProperties: false
query.profile_type — Optional Filter profiles by client type. When omitted, only WARP profiles are returned. $ref: "#/definitions/teams-devices_profile_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the default device settings profile — cloudflare.devices-get-default-device-settings-policy

Fetches the default device settings profile for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the default device settings profile — cloudflare.devices-update-default-device-settings-policy

Updates the default device settings profile for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.allow_mode_switch — Optional $ref: "#/definitions/teams-devices_allow_mode_switch"
body.allow_updates — Optional $ref: "#/definitions/teams-devices_allow_updates"
body.allowed_to_leave — Optional $ref: "#/definitions/teams-devices_allowed_to_leave"
body.auto_connect — Optional $ref: "#/definitions/teams-devices_auto_connect"
body.captive_portal — Optional $ref: "#/definitions/teams-devices_captive_portal"
body.disable_auto_fallback — Optional $ref: "#/definitions/teams-devices_disable_auto_fallback"
body.dns_search_suffixes — Optional $ref: "#/definitions/teams-devices_dns_search_suffixes"
body.enable_device_credential_authentication — Optional $ref: "#/definitions/teams-devices_enable_device_credential_authentication"
body.exclude — Optional $ref: "#/definitions/teams-devices_exclude_request"
body.exclude_office_ips — Optional $ref: "#/definitions/teams-devices_exclude_office_ips"
body.global_acceleration — Optional $ref: "#/definitions/teams-devices_global_acceleration"
body.include — Optional $ref: "#/definitions/teams-devices_include_request"
body.lan_allow_minutes — Optional $ref: "#/definitions/teams-devices_lan_allow_minutes"
body.lan_allow_subnet_size — Optional $ref: "#/definitions/teams-devices_lan_allow_subnet_size"
body.register_interface_ip_with_dns — Optional $ref: "#/definitions/teams-devices_register_interface_ip_with_dns"
body.sccm_vpn_boundary_support — Optional $ref: "#/definitions/teams-devices_sccm_vpn_boundary_support"
body.service_mode_v2 — Optional $ref: "#/definitions/teams-devices_service_mode_v2"
body.support_url — Optional $ref: "#/definitions/teams-devices_support_url"
body.switch_locked — Optional $ref: "#/definitions/teams-devices_switch_locked"
body.tunnel_protocol — Optional $ref: "#/definitions/teams-devices_tunnel_protocol"
body.uninstall_protection — Optional $ref: "#/definitions/teams-devices_uninstall_protection"
body.virtual_networks — Optional $ref: "#/definitions/teams-devices_virtual_networks"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a device settings profile — cloudflare.devices-create-device-settings-policy

Creates a device settings profile to be applied to certain devices matching the criteria.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.allow_mode_switch — Optional $ref: "#/definitions/teams-devices_allow_mode_switch"
body.allow_updates — Optional $ref: "#/definitions/teams-devices_allow_updates"
body.allowed_to_leave — Optional $ref: "#/definitions/teams-devices_allowed_to_leave"
body.auto_connect — Optional $ref: "#/definitions/teams-devices_auto_connect"
body.browser_extension_config — Optional $ref: "#/definitions/teams-devices_browser_extension_config"
body.captive_portal — Optional $ref: "#/definitions/teams-devices_captive_portal"
body.default — Optional $ref: "#/definitions/teams-devices_default"
body.description — Optional
body.description — Optional allOf[1]; $ref: "#/definitions/teams-devices_schemas-description"
body.description string Optional allOf[2]; default: ""
body.disable_auto_fallback — Optional $ref: "#/definitions/teams-devices_disable_auto_fallback"
body.dns_search_suffixes — Optional $ref: "#/definitions/teams-devices_dns_search_suffixes"
body.enable_device_credential_authentication — Optional $ref: "#/definitions/teams-devices_enable_device_credential_authentication"
body.enabled boolean Optional Whether the policy will be applied to matching devices. default: true
body.exclude — Optional $ref: "#/definitions/teams-devices_exclude_request"
body.exclude_office_ips — Optional $ref: "#/definitions/teams-devices_exclude_office_ips"
body.global_acceleration — Optional $ref: "#/definitions/teams-devices_global_acceleration"
body.include — Optional $ref: "#/definitions/teams-devices_include_request"
body.lan_allow_minutes — Optional $ref: "#/definitions/teams-devices_lan_allow_minutes"
body.lan_allow_subnet_size — Optional $ref: "#/definitions/teams-devices_lan_allow_subnet_size"
body.match — Optional $ref: "#/definitions/teams-devices_schemas-match"
body.name string Required The name of the device settings profile. maxLength: 100
body.precedence — Optional $ref: "#/definitions/teams-devices_precedence"
body.profile_type — Optional $ref: "#/definitions/teams-devices_profile_type"
body.register_interface_ip_with_dns — Optional $ref: "#/definitions/teams-devices_register_interface_ip_with_dns"
body.sccm_vpn_boundary_support — Optional $ref: "#/definitions/teams-devices_sccm_vpn_boundary_support"
body.service_mode_v2 — Optional $ref: "#/definitions/teams-devices_service_mode_v2"
body.support_url — Optional $ref: "#/definitions/teams-devices_support_url"
body.switch_locked — Optional $ref: "#/definitions/teams-devices_switch_locked"
body.tunnel_protocol — Optional $ref: "#/definitions/teams-devices_tunnel_protocol"
body.uninstall_protection — Optional $ref: "#/definitions/teams-devices_uninstall_protection"
body.virtual_networks — Optional $ref: "#/definitions/teams-devices_virtual_networks"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Allow Developers"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset Split Tunnel exclude list — cloudflare.devices-delete-split-tunnel-exclude-list

Resets the Split Tunnel exclude list to the default value.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
query object Optional additionalProperties: false
query.reset_defaults boolean Optional Deprecated and ignored. Deleting the list always restores the defaults. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Split Tunnel exclude list — cloudflare.devices-get-split-tunnel-exclude-list

Fetches the list of routes excluded from the WARP client's tunnel.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the Split Tunnel exclude list — cloudflare.devices-set-split-tunnel-exclude-list

Sets the list of routes excluded from the WARP client's tunnel.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body array Required
body[] — Optional $ref: "#/definitions/teams-devices_split_tunnel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset Local Domain Fallback — cloudflare.devices-delete-local-domain-fallback-list

Restores the default Local Domain Fallback list for the default device profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
query object Optional additionalProperties: false
query.reset_defaults boolean Optional Deprecated and ignored. Deleting the list always restores the defaults. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get your Local Domain Fallback list — cloudflare.devices-get-local-domain-fallback-list

Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set your Local Domain Fallback list — cloudflare.devices-set-local-domain-fallback-list

Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body array Required
body[] — Optional $ref: "#/definitions/teams-devices_fallback_domain"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Split Tunnel include list — cloudflare.devices-get-split-tunnel-include-list

Fetches the list of routes included in the WARP client's tunnel.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the Split Tunnel include list — cloudflare.devices-set-split-tunnel-include-list

Sets the list of routes included in the WARP client's tunnel.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body array Required
body[] — Optional $ref: "#/definitions/teams-devices_split_tunnel_include"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a device settings profile — cloudflare.devices-delete-device-settings-policy

Deletes a device settings profile and fetches a list of the remaining profiles for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get device settings profile by ID — cloudflare.devices-get-device-settings-policy-by-id

Fetches a device settings profile by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a device settings profile — cloudflare.devices-update-device-settings-policy

Updates a configured device settings profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.allow_mode_switch — Optional $ref: "#/definitions/teams-devices_allow_mode_switch"
body.allow_updates — Optional $ref: "#/definitions/teams-devices_allow_updates"
body.allowed_to_leave — Optional $ref: "#/definitions/teams-devices_allowed_to_leave"
body.auto_connect — Optional $ref: "#/definitions/teams-devices_auto_connect"
body.browser_extension_config — Optional $ref: "#/definitions/teams-devices_browser_extension_config"
body.captive_portal — Optional $ref: "#/definitions/teams-devices_captive_portal"
body.default — Optional $ref: "#/definitions/teams-devices_default"
body.description — Optional $ref: "#/definitions/teams-devices_schemas-description"
body.disable_auto_fallback — Optional $ref: "#/definitions/teams-devices_disable_auto_fallback"
body.dns_search_suffixes — Optional $ref: "#/definitions/teams-devices_dns_search_suffixes"
body.enable_device_credential_authentication — Optional $ref: "#/definitions/teams-devices_enable_device_credential_authentication"
body.enabled boolean Optional Whether the policy will be applied to matching devices.
body.exclude — Optional $ref: "#/definitions/teams-devices_exclude_request"
body.exclude_office_ips — Optional $ref: "#/definitions/teams-devices_exclude_office_ips"
body.global_acceleration — Optional $ref: "#/definitions/teams-devices_global_acceleration"
body.include — Optional $ref: "#/definitions/teams-devices_include_request"
body.lan_allow_minutes — Optional $ref: "#/definitions/teams-devices_lan_allow_minutes"
body.lan_allow_subnet_size — Optional $ref: "#/definitions/teams-devices_lan_allow_subnet_size"
body.match — Optional $ref: "#/definitions/teams-devices_schemas-match"
body.name string Optional The name of the device settings profile. maxLength: 100
body.precedence — Optional $ref: "#/definitions/teams-devices_precedence"
body.register_interface_ip_with_dns — Optional $ref: "#/definitions/teams-devices_register_interface_ip_with_dns"
body.sccm_vpn_boundary_support — Optional $ref: "#/definitions/teams-devices_sccm_vpn_boundary_support"
body.service_mode_v2 — Optional $ref: "#/definitions/teams-devices_service_mode_v2"
body.support_url — Optional $ref: "#/definitions/teams-devices_support_url"
body.switch_locked — Optional $ref: "#/definitions/teams-devices_switch_locked"
body.tunnel_protocol — Optional $ref: "#/definitions/teams-devices_tunnel_protocol"
body.uninstall_protection — Optional $ref: "#/definitions/teams-devices_uninstall_protection"
body.virtual_networks — Optional $ref: "#/definitions/teams-devices_virtual_networks"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset Split Tunnel exclude list — cloudflare.devices-delete-split-tunnel-exclude-list-for-a-device-settings-policy

Resets the Split Tunnel exclude list to the default value for the selected device profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
query object Optional additionalProperties: false
query.reset_defaults boolean Optional Deprecated and ignored. Deleting the list always restores the defaults. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Split Tunnel exclude list for a device settings profile — cloudflare.devices-get-split-tunnel-exclude-list-for-a-device-settings-policy

Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the Split Tunnel exclude list for a device settings profile — cloudflare.devices-set-split-tunnel-exclude-list-for-a-device-settings-policy

Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body array Required
body[] — Optional $ref: "#/definitions/teams-devices_split_tunnel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset Local Domain Fallback — cloudflare.devices-delete-local-domain-fallback-list-for-a-device-set-d98d3493e3

Restores the default Local Domain Fallback list for a specific device profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
query object Optional additionalProperties: false
query.reset_defaults boolean Optional Deprecated and ignored. Deleting the list always restores the defaults. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Local Domain Fallback list for a device settings profile — cloudflare.devices-get-local-domain-fallback-list-for-a-device-settings-policy

Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the Local Domain Fallback list for a device settings profile — cloudflare.devices-set-local-domain-fallback-list-for-a-device-settings-policy

Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body array Required
body[] — Optional $ref: "#/definitions/teams-devices_fallback_domain"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Split Tunnel include list for a device settings profile — cloudflare.devices-get-split-tunnel-include-list-for-a-device-settings-policy

Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the Split Tunnel include list for a device settings profile — cloudflare.devices-set-split-tunnel-include-list-for-a-device-settings-policy

Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/teams-devices_schemas-uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body array Required
body[] — Optional $ref: "#/definitions/teams-devices_split_tunnel_include"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List posture rules — cloudflare.device-posture-rules-list-device-posture-rules

Fetches device posture rules for a Zero Trust account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create posture rule — cloudflare.device-posture-rules-create-device-posture-rule

Creates a new device posture rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.description — Optional $ref: "#/definitions/teams-devices_description"
body.expiration — Optional $ref: "#/definitions/teams-devices_expiration"
body.input — Optional $ref: "#/definitions/teams-devices_input"
body.match — Optional $ref: "#/definitions/teams-devices_match"
body.name — Required $ref: "#/definitions/teams-devices_name"
body.schedule — Optional $ref: "#/definitions/teams-devices_schedule"
body.type — Required $ref: "#/definitions/teams-devices_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Admin Serial Numbers",
    "type": "file"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List posture integrations — cloudflare.device-posture-integrations-list-device-posture-integrations

Fetches the list of device posture integrations for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete posture integration — cloudflare.device-posture-integrations-delete-device-posture-integration

Delete a configured device posture integration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.integration_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "integration_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get posture integration — cloudflare.device-posture-integrations-device-posture-integration-details

Fetches details for a single device posture integration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.integration_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "integration_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update posture integration — cloudflare.device-posture-integrations-update-device-posture-integration

Updates a configured device posture integration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.integration_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.config — Optional
body.config — Optional allOf[1]; $ref: "#/definitions/teams-devices_config_request"
body.interval — Optional $ref: "#/definitions/teams-devices_interval"
body.name — Optional $ref: "#/definitions/teams-devices_components-schemas-name"
body.type — Optional $ref: "#/definitions/teams-devices_schemas-type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "integration_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete posture rule — cloudflare.device-posture-rules-delete-device-posture-rule

Deletes a device posture rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get posture rule — cloudflare.device-posture-rules-device-posture-rules-details

Fetches a single device posture rule.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update posture rule — cloudflare.device-posture-rules-update-device-posture-rule

Updates a device posture rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/teams-devices_uuid"
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body object Required
body.description — Optional $ref: "#/definitions/teams-devices_description"
body.expiration — Optional $ref: "#/definitions/teams-devices_expiration"
body.input — Optional $ref: "#/definitions/teams-devices_input"
body.match — Optional $ref: "#/definitions/teams-devices_match"
body.name — Required $ref: "#/definitions/teams-devices_name"
body.schedule — Optional $ref: "#/definitions/teams-devices_schedule"
body.type — Required $ref: "#/definitions/teams-devices_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Admin Serial Numbers",
    "type": "file"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete registrations — cloudflare.delete-registrations

Deletes a list of WARP registrations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Required additionalProperties: false
query.id array Required A list of registration IDs to delete.
query.id[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "id": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List registrations — cloudflare.list-registrations

Lists WARP registrations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.user.id array Optional Filter by user ID.
query.user.id[] string Optional
query.seen_after string Optional Filter by the last_seen timestamp - returns only registrations last seen after this timestamp.
query.seen_before string Optional Filter by the last_seen timestamp - returns only registrations last seen before this timestamp.
query.status string Optional Filter by registration status. Defaults to 'active'. enum: ["active","all","revoked"]
query.registration_type — Optional Filter by registration client type. $ref: "#/definitions/teams-devices_registration_type"
query.per_page integer Optional The maximum number of devices to return in a single response.
query.search string Optional Filter by registration details.
query.sort_by string Optional The registration field to order results by. enum: ["id","user.name","user.email","last_seen_at","created_at"]
query.sort_order string Optional Sort direction. enum: ["asc","desc"]
query.cursor string Optional Opaque token indicating the starting position when requesting the next set of records. A cursor value can be obtained from the result_info.cursor field in the response.
query.id array Optional Filter by registration ID.
query.id[] string Optional
query.device.id string Optional Filter by WARP device ID.
query.policy.id string Optional Filter by the ID of the device settings profile assigned to the registration. format: "uuid"
query.include string Optional Comma-separated list of additional information that should be included in the registration response. Supported values are: "policy".

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete registration — cloudflare.delete-registration

Deletes a WARP registration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.registration_id string Required
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "registration_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get registration — cloudflare.get-registration

Fetches a single WARP registration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.registration_id string Required
path.account_id string Required
query object Optional additionalProperties: false
query.include string Optional Comma-separated list of additional information that should be included in the registration response. Supported values are: "policy".

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "registration_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get override codes — cloudflare.get-registration-override-codes

Fetches one-time use admin override codes for a registration. This relies on the Admin Override setting being enabled in your device configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.registration_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "registration_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Global Disconnect — cloudflare.devices-resilience-retrieve-global-warp-override

Fetch the Global WARP disconnect state.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Global Disconnect — cloudflare.devices-resilience-set-global-warp-override

Sets the Global WARP disconnect state.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body — Required $ref: "#/definitions/teams-devices_global_warp_override_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "disconnect": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset device settings — cloudflare.zero-trust-accounts-delete-device-settings-for-zero-trust-account

Resets the current device settings for a Zero Trust account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get device settings — cloudflare.zero-trust-accounts-get-device-settings-for-zero-trust-account

Describes the current device settings for a Zero Trust account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update device settings — cloudflare.zero-trust-accounts-patch-device-settings-for-the-zero-trust-account

Updates the device settings for a Zero Trust account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/teams-devices_identifier"
body — Required $ref: "#/definitions/teams-devices_zero-trust-account-device-settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Cloudflare colos — cloudflare.dex-endpoints-list-colos

List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.from string Required Start time for connection period in ISO (RFC3339 - ISO 8601) format.
query.to string Required End time for connection period in ISO (RFC3339 - ISO 8601) format.
query.sortBy string Optional Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically. enum: ["fleet-status-usage","application-tests-usage"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "from": "2023-08-20T20:45:00Z",
    "to": "2023-08-24T20:45:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account commands — cloudflare.get-commands

Retrieves a paginated list of commands issued to devices under the specified account, optionally filtered by time range, device, or other parameters

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.page number Required Page number of paginated results. default: 1; minimum: 1
query.per_page number Required Number of results per page. minimum: 1; maximum: 50
query.from string Optional Start time for the query in ISO (RFC3339 - ISO 8601) format. format: "date-time"
query.to string Optional End time for the query in ISO (RFC3339 - ISO 8601) format. format: "date-time"
query.device_id string Optional Unique identifier for a device.
query.user_email string Optional Email tied to the device.
query.command_type string Optional Optionally filter executed commands by command type. enum: ["pcap","speed-test","warp-diag"]
query.status string Optional Optionally filter executed commands by status. enum: ["PENDING_EXEC","PENDING_UPLOAD","SUCCESS","FAILED"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create account commands — cloudflare.post-commands

Initiate commands for up to 10 devices per account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
body object Required
body.commands array Required List of device-level commands to execute maxItems: 20
body.commands[] object Optional
body.commands[].args object Optional Command arguments. Allowed fields depend on type.
body.commands[].args object Optional warp-diag args oneOf[1]; additionalProperties: false
body.commands[].args.test-all-routes boolean Optional Test an IP address from all included or excluded ranges. Essentially the same as running 'route get <ip>' and collecting the results. This option may increase the time taken to collect the warp-diag. oneOf[1]; default: true
body.commands[].args object Optional pcap args oneOf[2]; additionalProperties: false
body.commands[].args.max-file-size-mb number Optional Maximum file size (in MB) for the capture file. If the capture artifact exceeds the specified max file size, it will NOT be uploaded. oneOf[2]; default: 5; minimum: 1
body.commands[].args.packet-size-bytes number Optional Maximum number of bytes to save for each packet oneOf[2]; default: 160; minimum: 1
body.commands[].args.time-limit-min number Optional Limit on capture duration (in minutes) oneOf[2]; default: 5; minimum: 1
body.commands[].args object Optional speed-test args oneOf[3]; additionalProperties: false
body.commands[].args.interfaces array Optional List of interfaces to run the speed test on oneOf[3]
body.commands[].args.interfaces[] string Optional oneOf[3]; enum: ["default","tunnel"]
body.commands[].device_id string Required Unique identifier for the physical device
body.commands[].registration_id string Optional Unique identifier for the device registration. Required for multi-user devices to target the correct user session.
body.commands[].type string Required Type of command to execute on the device enum: ["pcap","speed-test","warp-diag"]
body.commands[].user_email string Required Email tied to the device

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "commands": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List devices eligible for remote captures — cloudflare.get-commands-eligible-devices

List devices with WARP client support for remote captures which have been connected in the last 1 hour.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.page number Required Page number of paginated results. default: 1; minimum: 1
query.per_page number Required Number of results per page. minimum: 1; maximum: 50
query.search string Optional Filter devices by name or email.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns account commands usage, quota, and reset time — cloudflare.get-commands-quota

Retrieves the current quota usage and limits for device commands within a specific account, including the time when the quota will reset

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Device DEX tests — cloudflare.device-dex-test-details

Fetch all DEX tests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of results per page. default: 10; minimum: 1; maximum: 50
query.testName string Optional Filter by test name.
query.kind string Optional Filter by test type. enum: ["http","traceroute"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Device DEX test — cloudflare.device-dex-test-create-device-dex-test

Create a DEX test.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
body — Required $ref: "#/definitions/digital-experience-monitoring_device-dex-test-schemas-http"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "name": "HTTP dash health check",
    "interval": "30m",
    "enabled": true,
    "data": {
      "host": "https://dash.cloudflare.com",
      "kind": "http",
      "method": "GET"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Device DEX test — cloudflare.device-dex-test-delete-device-dex-test

Delete a Device DEX test. Returns the remaining device dex tests for the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.dex_test_id — Required Unique identifier for a DEX test. $ref: "#/definitions/digital-experience-monitoring_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "dex_test_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Device DEX test — cloudflare.device-dex-test-get-device-dex-test

Fetch a single DEX test.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.dex_test_id — Required Unique identifier for a DEX test. $ref: "#/definitions/digital-experience-monitoring_schemas-test-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "dex_test_id": "372e67954025e0ba6aaa6d586b9e0b59"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Device DEX test — cloudflare.device-dex-test-update-device-dex-test

Update a DEX test.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.dex_test_id — Required Unique identifier for a DEX test. $ref: "#/definitions/digital-experience-monitoring_uuid"
body — Required $ref: "#/definitions/digital-experience-monitoring_device-dex-test-schemas-http"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "dex_test_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "name": "HTTP dash health check",
    "interval": "30m",
    "enabled": true,
    "data": {
      "host": "https://dash.cloudflare.com",
      "kind": "http",
      "method": "GET"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the latest status of a device. — cloudflare.devices-live-status

Get the latest status of a device given device_id from the device_state table.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.device_id — Required Device-specific ID, given as UUID. $ref: "#/definitions/digital-experience-monitoring_device_id"
query object Required additionalProperties: false
query.since_minutes — Required Number of minutes before current time. $ref: "#/definitions/digital-experience-monitoring_since_minutes"
query.time_now — Optional Current time in ISO format. $ref: "#/definitions/digital-experience-monitoring_time_now"
query.colo — Optional List of data centers to filter results. $ref: "#/definitions/digital-experience-monitoring_colo"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "device_id": "cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7"
  },
  "query": {
    "since_minutes": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the status over time for a device — cloudflare.dex-device-status-over-time

Get time-bucketed status metrics for a specific device.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.device_id — Required Device-specific ID, given as UUID. $ref: "#/definitions/digital-experience-monitoring_device_id"
query object Required additionalProperties: false
query.from — Required Start of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch. $ref: "#/definitions/digital-experience-monitoring_timestamp"
query.to — Required End of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch. $ref: "#/definitions/digital-experience-monitoring_timestamp"
query.interval string Required Time interval for aggregate time slots. enum: ["minute","hour"]
query.colo — Optional List of data centers to filter results. $ref: "#/definitions/digital-experience-monitoring_colo"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "device_id": "cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7"
  },
  "query": {
    "from": "2023-10-11 00:00:00+00",
    "to": "2023-10-11 00:00:00+00",
    "interval": "minute"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List device ISPs — cloudflare.dex-endpoints-list-device-isps

List ISP information observed for a specific device during traceroute tests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.device_id — Required Device-specific ID, given as UUID. $ref: "#/definitions/digital-experience-monitoring_uuid"
query object Required additionalProperties: false
query.page integer Optional Page number of paginated results. Mutually exclusive with cursor. default: 1; minimum: 1
query.per_page integer Required Number of items per page minimum: 1; maximum: 50
query.cursor string Optional Cursor for cursor-based pagination. Mutually exclusive with page.
query.sort_by string Optional The field to sort results by. enum: ["time_start"]; default: "time_start"
query.sort_order string Optional The order to sort results. enum: ["ASC","DESC"]; default: "DESC"
query.from string Optional Start time for the query in ISO 8601 format. format: "date-time"
query.to string Optional End time for the query in ISO 8601 format. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "device_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "query": {
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List details of devices using WARP. — cloudflare.dex-fleet-status-devices

List details of devices using WARP.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.to — Required End of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch. $ref: "#/definitions/digital-experience-monitoring_timestamp"
query.from — Required Start of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch. $ref: "#/definitions/digital-experience-monitoring_timestamp"
query.page — Required Page number of paginated results. $ref: "#/definitions/digital-experience-monitoring_page"
query.per_page — Required Number of results per page. $ref: "#/definitions/digital-experience-monitoring_per_page"
query.sort_by — Optional Dimension to sort results by. $ref: "#/definitions/digital-experience-monitoring_sort_by"
query.colo — Optional Cloudflare colo airport code. $ref: "#/definitions/digital-experience-monitoring_colo"
query.device_id — Optional Device-specific ID, given as UUID. $ref: "#/definitions/digital-experience-monitoring_device_id"
query.mode — Optional The mode under which the WARP client is run. $ref: "#/definitions/digital-experience-monitoring_mode"
query.status — Optional Network status. $ref: "#/definitions/digital-experience-monitoring_status"
query.platform — Optional Operating system. $ref: "#/definitions/digital-experience-monitoring_platform"
query.version — Optional WARP client version. $ref: "#/definitions/digital-experience-monitoring_version"
query.source — Optional Source: * hourly - device details aggregated hourly, up to 7 days prior * last_seen - device details, up to 60 minutes prior. Time windows exceeding 60 minutes will be rejected from June 1st, 2026. Please use 'hourly' or 'raw' instead for longer time ranges. * raw - device details, up to 7 days prior $ref: "#/definitions/digital-experience-monitoring_source"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "to": "2023-10-11 00:00:00+00",
    "from": "2023-10-11 00:00:00+00",
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get live aggregate device details by dimension — cloudflare.dex-fleet-status-live

Get details for live (up to 60 minutes) devices using WARP.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.since_minutes — Required Number of minutes before current time. $ref: "#/definitions/digital-experience-monitoring_since_minutes"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "since_minutes": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get over time aggregate details for devices by dimension — cloudflare.dex-fleet-status-over-time

Get aggregate details for devices using WARP, up to 7 days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.to — Required End of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch. $ref: "#/definitions/digital-experience-monitoring_timestamp"
query.from — Required Start of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch. $ref: "#/definitions/digital-experience-monitoring_timestamp"
query.colo — Optional Cloudflare colo airport code. $ref: "#/definitions/digital-experience-monitoring_colo"
query.device_id — Optional Device-specific ID, given as UUID. $ref: "#/definitions/digital-experience-monitoring_device_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "to": "2023-10-11 00:00:00+00",
    "from": "2023-10-11 00:00:00+00"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get percentiles for an http test — cloudflare.dex-endpoints-http-test-percentiles

Get percentiles for an http test for a given time period between 1 hour and 7 days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.test_id — Required Unique identifier for a specific test. $ref: "#/definitions/digital-experience-monitoring_uuid"
query object Required additionalProperties: false
query.deviceId array Optional Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
query.deviceId[] string Optional Unique identifier for the physical device (UUID).
query.from string Required Start time for the query in ISO (RFC3339 - ISO 8601) format.
query.to string Required End time for the query in ISO (RFC3339 - ISO 8601) format.
query.colo string Optional Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "test_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "query": {
    "from": "2023-09-20T17:00:00Z",
    "to": "2023-09-20T17:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DEX Rules — cloudflare.list-dex-rules

List DEX Rules.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.page number Required Page number of paginated results. default: 1; minimum: 1
query.per_page number Required Number of results per page. minimum: 1; maximum: 50
query.sort_order string Optional Sort direction for sort_by property. enum: ["ASC","DESC"]; default: "ASC"
query.sort_by string Optional Which property to sort results by. enum: ["name","created_at","updated_at"]; default: "name"
query.name string Optional Filter results by rule name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "page": 1,
    "per_page": 10
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a DEX Rule — cloudflare.create-dex-rule

Create a DEX Rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
body — Required $ref: "#/definitions/digital-experience-monitoring_create_rule_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "name": "example",
    "match": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a DEX Rule — cloudflare.delete-dex-rule

Delete a DEX Rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.rule_id — Required Unique identifier of the rule. $ref: "#/definitions/digital-experience-monitoring_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DEX Rule — cloudflare.get-dex-rule

Get details for a DEX Rule.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.rule_id — Required Unique identifier of the rule. $ref: "#/definitions/digital-experience-monitoring_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a DEX Rule — cloudflare.update-dex-rule

Update a DEX Rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.rule_id — Required Unique identifier of the rule. $ref: "#/definitions/digital-experience-monitoring_uuid"
body — Required $ref: "#/definitions/digital-experience-monitoring_patch_rule_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DEX test analytics — cloudflare.dex-endpoints-list-tests-overview

List DEX tests with overview metrics.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Optional additionalProperties: false
query.colo string Optional Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
query.testName string Optional Optionally filter results by test name.
query.deviceId array Optional Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
query.deviceId[] string Optional Unique identifier for the physical device (UUID).
query.registration_id string Optional Optionally filter results to a specific device registration. Must be used in combination with a single deviceId.
query.page number Optional Page number of paginated results default: 1; minimum: 1
query.per_page number Optional Number of items per page default: 10; minimum: 1; maximum: 50
query.kind string Optional Filter by test type. enum: ["http","traceroute"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get count of devices targeted — cloudflare.dex-endpoints-tests-unique-devices

Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Optional additionalProperties: false
query.testName string Optional Optionally filter results by test name.
query.deviceId array Optional Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
query.deviceId[] string Optional Unique identifier for the physical device (UUID).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get details for a specific traceroute test run — cloudflare.dex-endpoints-traceroute-test-result-network-path

Get a breakdown of hops and performance metrics for a specific traceroute test run

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.test_result_id — Required Unique identifier for a specific traceroute test. $ref: "#/definitions/digital-experience-monitoring_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "test_result_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get percentiles for a traceroute test — cloudflare.dex-endpoints-traceroute-test-percentiles

Get percentiles for a traceroute test for a given time period between 1 hour and 7 days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
path.test_id — Required Unique identifier for a specific test. $ref: "#/definitions/digital-experience-monitoring_uuid"
query object Required additionalProperties: false
query.deviceId array Optional Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
query.deviceId[] string Optional
query.from string Required Start time for the query in ISO (RFC3339 - ISO 8601) format.
query.to string Required End time for the query in ISO (RFC3339 - ISO 8601) format.
query.colo string Optional Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "test_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "query": {
    "from": "2023-09-20T17:00:00Z",
    "to": "2023-09-20T17:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List WARP change events. — cloudflare.list-warp-change-events

List WARP configuration and enablement toggle change events by device.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Unique Cloudflare account ID. $ref: "#/definitions/digital-experience-monitoring_account_identifier"
query object Required additionalProperties: false
query.page number Required Page number of paginated results. default: 1; minimum: 1
query.per_page number Required Number of results per page. minimum: 1; maximum: 50
query.from string Required Start time for the query in ISO (RFC3339 - ISO 8601) format.
query.to string Required End time for the query in ISO (RFC3339 - ISO 8601) format.
query.type string Optional Filter events by type 'config' or 'toggle'. enum: ["config","toggle"]
query.toggle string Optional Filter events by type toggle value. Applicable to type='toggle' events only. enum: ["on","off"]
query.config_name string Optional Filter events by WARP configuration name changed from or to. Applicable to type='config' events only.
query.account_name string Optional Filter events by account name.
query.sort_order string Optional Sort response by event timestamp. enum: ["ASC","DESC"]; default: "ASC"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "query": {
    "page": 1,
    "per_page": 10,
    "from": "2023-09-20T17:00:00Z",
    "to": "2023-09-20T17:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Endpoint Health Checks — cloudflare.diagnostics-endpoint-healthcheck-list

List Endpoint Health Checks.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-transit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-create

Create Endpoint Health Check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-transit_identifier"
body — Required $ref: "#/definitions/magic-transit_endpoint_health_check"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "check_type": "icmp",
    "endpoint": "203.0.113.1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-delete

Delete Endpoint Health Check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-transit_identifier"
path.id — Required $ref: "#/definitions/magic-transit_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-get

Get a single Endpoint Health Check.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-transit_identifier"
path.id — Required $ref: "#/definitions/magic-transit_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Endpoint Health Check — cloudflare.diagnostics-endpoint-healthcheck-update

Update an Endpoint Health Check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-transit_identifier"
path.id — Required $ref: "#/definitions/magic-transit_uuid"
body — Required $ref: "#/definitions/magic-transit_endpoint_health_check"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "check_type": "icmp",
    "endpoint": "203.0.113.1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Traceroute — cloudflare.diagnostics-traceroute

Run traceroutes from Cloudflare colos.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-transit_identifier"
body object Required
body.colos — Optional $ref: "#/definitions/magic-transit_colos"
body.options — Optional $ref: "#/definitions/magic-transit_options"
body.targets — Required $ref: "#/definitions/magic-transit_targets"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "targets": [
      "203.0.113.1",
      "cloudflare.com"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom prompt topics — cloudflare.dlp-custom-prompt-topics-list

Lists all DLP custom prompt topic entries in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create custom prompt topic — cloudflare.dlp-custom-prompt-topics-create

Creates a DLP custom prompt topic entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewCustomPromptTopic"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example",
    "enabled": false,
    "topic": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete custom prompt topic — cloudflare.dlp-custom-prompt-topics-delete

Deletes a DLP custom prompt topic entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get custom prompt topic — cloudflare.dlp-custom-prompt-topics-get

Fetches a DLP custom prompt topic entry by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update custom prompt topic — cloudflare.dlp-custom-prompt-topics-update

Updates a DLP custom prompt topic entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_CustomPromptTopicUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example",
    "enabled": false,
    "topic": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all data classes in an account — cloudflare.dlp-data-classes-list

Lists data classes configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a new data class — cloudflare.dlp-data-classes-create

Creates a data class for use in DLP profiles.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewDataClass"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example",
    "expression": "example",
    "sensitivity_levels": [],
    "data_tags": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single data class — cloudflare.dlp-data-classes-delete

Deletes a data class from the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.data_class_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "data_class_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific data class — cloudflare.dlp-data-classes-read

Gets the configuration for a data class.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.data_class_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "data_class_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the attributes of a single data class — cloudflare.dlp-data-classes-update

Updates the configuration for a data class.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.data_class_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_DataClassUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "data_class_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all data tag categories in an account — cloudflare.dlp-data-tag-categories-list

Lists data tag categories configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a new data tag category. — cloudflare.dlp-data-tag-categories-create

Creates a data tag category, optionally from a template.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewDataTagCategory"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single data tag category. — cloudflare.dlp-data-tag-categories-delete

Deletes a data tag category and its tags.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific data tag category. — cloudflare.dlp-data-tag-categories-read

Gets a data tag category and its tags.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the attributes of a single data tag category. — cloudflare.dlp-data-tag-categories-update

Updates a data tag category and its tags.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_DataTagCategoryUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all data tags in a data tag category — cloudflare.dlp-data-tags-list

Lists data tags in a category.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a new data tag. — cloudflare.dlp-data-tags-create

Creates a data tag in a category.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_NewDataTag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single data tag. — cloudflare.dlp-data-tags-delete

Deletes a data tag from a category.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"
path.tag_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000",
    "tag_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific data tag. — cloudflare.dlp-data-tags-read

Gets a data tag from a category.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"
path.tag_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000",
    "tag_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the attributes of a single data tag. — cloudflare.dlp-data-tags-update

Updates a data tag in a category.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.category_id string Required format: "uuid"
path.tag_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_DataTagUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "category_id": "00000000-0000-4000-8000-000000000000",
    "tag_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all data tag category templates in an account — cloudflare.dlp-data-tag-category-templates-list

Lists available data tag category templates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific data tag category template. — cloudflare.dlp-data-tag-category-template-read

Gets an available data tag category template.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.template_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "template_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all datasets — cloudflare.dlp-datasets-read-all

Lists all DLP datasets configured for the account, including custom word lists and EDM datasets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new dataset — cloudflare.dlp-datasets-create

Creates a new DLP (Data Loss Prevention) dataset for storing custom detection patterns. Datasets can contain exact match data, word lists, or EDM (Exact Data Match) configurations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewDataset"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a dataset — cloudflare.dlp-datasets-delete

This deletes all versions of the dataset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.dataset_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch a specific dataset — cloudflare.dlp-datasets-read

Gets a dataset and its latest upload status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.dataset_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update details about a dataset — cloudflare.dlp-datasets-update

Updates the configuration of an existing DLP dataset, such as its name, description, or detection settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.dataset_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_DatasetUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Prepare to upload a new version of a dataset — cloudflare.dlp-datasets-create-version

Creates a new version of a DLP dataset, allowing you to stage changes before activation. Used for single-column EDM and custom word lists.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.dataset_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Sets the column information for a multi-column upload — cloudflare.dlp-datasets-define-columns

This is used for multi-column EDMv2 datasets. The EDMv2 format can only be created in the Cloudflare dashboard. The columns in the response appear in the same order as in the request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.dataset_id string Required format: "uuid"
path.version integer Required
body array Required
body[] — Optional $ref: "#/definitions/dlp_NewDatasetColumn"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "dataset_id": "00000000-0000-4000-8000-000000000000",
    "version": 1
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve data about all document fingerprints. — cloudflare.dlp-document-fingerprints-read-all

Lists all document fingerprints configured for DLP scanning in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a new document fingerprint. — cloudflare.dlp-document-fingerprints-create

Creates a new document fingerprint for DLP scanning. Document fingerprints detect documents that are structurally similar to the uploaded sample.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewDocumentFingerprint"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example",
    "match_percent": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single document fingerprint. — cloudflare.dlp-document-fingerprints-delete

Removes a document fingerprint from DLP configuration. Documents matching this fingerprint will no longer be detected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.document_fingerprint_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "document_fingerprint_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve data about a specific document fingerprint. — cloudflare.dlp-document-fingerprints-read

Gets a document fingerprint and its latest upload status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.document_fingerprint_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "document_fingerprint_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the attributes of a single document fingerprint. — cloudflare.dlp-document-fingerprints-update

Updates metadata for an existing document fingerprint, such as its name or description.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.document_fingerprint_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_UpdateDocumentFingerprint"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "document_fingerprint_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get mapping — cloudflare.dlp-email-scanner-get-account-mapping

Retrieves the email provider mapping configuration for DLP email scanning.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create mapping — cloudflare.dlp-email-scanner-create-account-mapping

Creates a mapping between a Cloudflare account and an email provider for DLP email scanning integration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_UpdateAddinAccountMapping"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "auth_requirements": {
      "allowed_microsoft_organizations": [],
      "type": "Org"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all email scanner rules — cloudflare.dlp-email-scanner-list-all-rules

Lists all email scanner rules for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update email scanner rule priorities — cloudflare.dlp-email-scanner-update-rule-priorities

Reorders DLP email scanning rules by updating their priority values. Higher priority rules are evaluated first.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_UpdateEmailRulePriorities"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "new_priorities": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create email scanner rule — cloudflare.dlp-email-scanner-create-rule

Creates a new DLP email scanning rule that defines what content patterns to detect in email messages and what actions to take.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_CreateEmailRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example",
    "enabled": false,
    "conditions": [],
    "action": {
      "action": "Block"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete email scanner rule — cloudflare.dlp-email-scanner-delete-rule

Removes a DLP email scanning rule. The rule will no longer be applied to email messages.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.rule_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "rule_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an email scanner rule — cloudflare.dlp-email-scanner-get-rule

Gets detailed configuration for a specific DLP email scanning rule, including detection patterns and actions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.rule_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "rule_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update email scanner rule — cloudflare.dlp-email-scanner-update-rule

Updates a DLP email scanning rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.rule_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_CreateEmailRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "rule_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example",
    "enabled": false,
    "conditions": [],
    "action": {
      "action": "Block"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all entries — cloudflare.dlp-entries-list-all-entries

Lists all DLP entries in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create custom entry — cloudflare.dlp-entries-create-entry

Creates a DLP custom entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewEntry"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example",
    "pattern": {
      "regex": "example"
    },
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update custom entry — cloudflare.dlp-entries-update-custom-entry

Updates a DLP custom entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_CustomEntryUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example",
    "pattern": {
      "regex": "example"
    },
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create integration entry — cloudflare.dlp-entries-create-integration-entry

Integration entries can't be created, this will update an existing integration entry. This is needed for our generated terraform API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewPredefinedEntry"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "enabled": false,
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete integration entry — cloudflare.dlp-entries-delete-integration-entry

This is a no-op as integration entires can't be deleted but is needed for our generated terraform API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update integration entry — cloudflare.dlp-entries-update-integration-entry

Updates a DLP entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_PredefinedEntryUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create predefined entry — cloudflare.dlp-entries-create-predefined-entry

Predefined entries can't be created, this will update an existing predefined entry. This is needed for our generated terraform API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewPredefinedEntry"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "enabled": false,
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete predefined entry — cloudflare.dlp-entries-delete-predefined-entry

This is a no-op as predefined entires can't be deleted but is needed for our generated terraform API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update predefined entry — cloudflare.dlp-entries-update-predefined-entry

Updates a DLP entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_PredefinedEntryUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete custom entry — cloudflare.dlp-entries-delete-entry

Deletes a DLP custom entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DLP Entry — cloudflare.dlp-entries-get-dlp-entry

Fetches a DLP entry by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update entry — cloudflare.dlp-entries-update-entry

Updates a DLP entry.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.entry_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_EntryUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "entry_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example",
    "pattern": {
      "regex": "example"
    },
    "type": "custom",
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch limits associated with DLP for account — cloudflare.dlp-limits-get

Retrieves current DLP usage limits and quotas for the account, including maximum allowed counts and current usage for custom entries, dataset cells, and document fingerprints.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate a DLP regex pattern — cloudflare.dlp-pattern-validate

Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. The regex will be rejected if it uses or +. Bound the maximum number of characters that can be matched using a range, e.g. {1,100}.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body — Required $ref: "#/definitions/dlp_RegexValidationQuery"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "regex": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all profiles — cloudflare.dlp-profiles-list-all-profiles

Lists all DLP profiles in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.all boolean Optional Return all profiles, including those that current account does not have access to.
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all custom profiles — cloudflare.dlp-profiles-list-all-custom-profiles

Lists all DLP custom profiles in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create custom profile — cloudflare.dlp-profiles-create-custom-profiles

Creates a DLP custom profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewCustomProfile"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete custom profile — cloudflare.dlp-profiles-delete-custom-profile

Deletes a DLP custom profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get custom profile — cloudflare.dlp-profiles-get-custom-profile

Fetches a custom DLP profile by id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update custom profile — cloudflare.dlp-profiles-update-custom-profile

Updates a DLP custom profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_CustomProfileUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete integration profile — cloudflare.dlp-profiles-delete-integration-profile

Deletes a DLP integration profile whose integration no longer exists. If the profile owns entries, recursive=1 is required. This also deletes the entries and removes all references to them, as listed by the references endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.recursive integer Optional Set to 1 to also delete the entries owned by the profile and remove all references to them, as listed by the references endpoint. Required if the profile owns any entries. Defaults to 0. minimum: 0; maximum: 1
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List integration profile references — cloudflare.dlp-profiles-list-integration-profile-references

Lists the profiles and data classes that reference the entries of a DLP integration profile, shows how each data class would change if the profile is deleted with recursive=1, and reports whether the integration that manages the profile still exists.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create predefined profile — cloudflare.dlp-profiles-create-predefined-profile

Creates a DLP predefined profile. Only supports enabling/disabling entries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewPredefinedProfile"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete predefined profile — cloudflare.dlp-profiles-delete-predefined-profile

This is a no-op as predefined profiles can't be deleted but is needed for our generated terraform API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get predefined profile — cloudflare.dlp-profiles-get-predefined-profile

Fetches a predefined DLP profile by id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update predefined profile — cloudflare.dlp-profiles-update-predefined-profile

Updates a DLP predefined profile. Only supports enabling/disabling entries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_PredefinedProfileUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get predefined profile config — cloudflare.dlp-profiles-get-predefined-profile-config

This is similar to get_predefined but only returns entries that are enabled. This is needed for our terraform API Fetches a predefined DLP profile by id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create predefined profile — cloudflare.dlp-profiles-create-predefined-profile-config

This is similar to update_predefined but only returns entries that are enabled. This is needed for our terraform API Creates a DLP predefined profile. Only supports enabling/disabling entries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_PredefinedProfileConfigUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update predefined profile config — cloudflare.dlp-profiles-update-predefined-profile-config

This is similar to update_predefined but only returns entries that are enabled. This is needed for our terraform API Updates a DLP predefined profile. Only supports enabling/disabling entries.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_PredefinedProfileConfigUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DLP Profile — cloudflare.dlp-profiles-get-dlp-profile

Fetches a DLP profile by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.profile_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "profile_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all sensitivity groups in an account — cloudflare.dlp-sensitivity-groups-list

Lists sensitivity groups configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a new sensitivity group. — cloudflare.dlp-sensitivity-groups-create

Creates a sensitivity group, optionally from a template.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_NewSensitivityGroup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all sensitivity group templates in an account — cloudflare.dlp-sensitivity-group-templates-list

Lists available sensitivity group templates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific sensitivity group template. — cloudflare.dlp-sensitivity-group-template-read

Gets an available sensitivity group template.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.template_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "template_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single sensitivity group. — cloudflare.dlp-sensitivity-groups-delete

Deletes a sensitivity group and its levels.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific sensitivity group. — cloudflare.dlp-sensitivity-groups-read

Gets a sensitivity group and its levels.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the attributes of a single sensitivity group. — cloudflare.dlp-sensitivity-groups-update

Updates a sensitivity group and its levels.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_SensitivityGroupUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve the ordered list of level IDs for a sensitivity group. — cloudflare.dlp-sensitivity-groups-get-level-order

Gets the current order of sensitivity levels in a group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the ordering of levels within a sensitivity group. — cloudflare.dlp-sensitivity-groups-put-level-order

Updates the order of sensitivity levels in a group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_SensitivityLevelOrder"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "level_ids": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all sensitivity levels in a sensitivity group — cloudflare.dlp-sensitivity-levels-list

Lists sensitivity levels in a sensitivity group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a new sensitivity level. — cloudflare.dlp-sensitivity-levels-create

Creates a sensitivity level in a group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_NewSensitivityLevel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single sensitivity level. — cloudflare.dlp-sensitivity-levels-delete

Deletes a sensitivity level from a group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"
path.sensitivity_level_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000",
    "sensitivity_level_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific sensitivity level. — cloudflare.dlp-sensitivity-levels-read

Gets a sensitivity level from a group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"
path.sensitivity_level_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000",
    "sensitivity_level_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the attributes of a single sensitivity level. — cloudflare.dlp-sensitivity-levels-update

Updates a sensitivity level in a group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.sensitivity_group_id string Required format: "uuid"
path.sensitivity_level_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_SensitivityLevelUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "sensitivity_group_id": "00000000-0000-4000-8000-000000000000",
    "sensitivity_level_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete (reset) DLP account-level settings to initial values. — cloudflare.dlp-settings-delete

Deletes account-level DLP settings and returns the initial values.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DLP account-level settings. — cloudflare.dlp-settings-get

Gets the account-level DLP settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Partially update DLP account-level settings. — cloudflare.dlp-settings-edit

Missing fields keep their existing values.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_DlpSettingsUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update DLP account-level settings (full replacement). — cloudflare.dlp-settings-update

Missing fields are reset to initial (unconfigured) values.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_DlpSettingsUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List validators — cloudflare.dlp-validators-list-validators

Lists the validators configured for the account, of every kind.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.kind — Optional Only return validators of this kind. Omit to return every kind.
query.kind — Optional allOf[1]; $ref: "#/definitions/dlp_ValidatorKind"
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List proximity word validators — cloudflare.dlp-validators-list-proximity-words-validators

Lists the proximity_words validators configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a proximity word validator — cloudflare.dlp-validators-create-proximity-words-validator

Creates a reusable list of weighted words that detection entries can attach to in order to refine their matches. An account may own at most 100 validators across all kinds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_ProximityWordValidatorWrite"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "HIPAA context words",
    "words": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a proximity word validator — cloudflare.dlp-validators-delete-proximity-words-validator

Deletes a proximity_words validator. Fails with 409 while any detection entry is still attached to it; detach it from those entries first.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a proximity word validator — cloudflare.dlp-validators-get-proximity-words-validator

Fetches a proximity_words validator by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a proximity word validator — cloudflare.dlp-validators-update-proximity-words-validator

Replaces the name and word list of a proximity_words validator. Attachments to detection entries are owned from the entry side and are not affected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_ProximityWordValidatorWrite"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "HIPAA context words",
    "words": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List worker validators — cloudflare.dlp-validators-list-worker-validators

Lists the worker validators configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a worker validator — cloudflare.dlp-validators-create-worker-validator

Registers a customer Worker as a validator. An account may own at most 100 validators across all kinds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_WorkerValidatorWrite"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "Invoice scorer",
    "script_tag": "0123456789abcdef0123456789abcdef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a worker validator — cloudflare.dlp-validators-delete-worker-validator

Deletes a worker validator. Fails with 409 while any detection entry is still attached to it; detach it from those entries first.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a worker validator — cloudflare.dlp-validators-get-worker-validator

Fetches a worker validator by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a worker validator — cloudflare.dlp-validators-update-worker-validator

Replaces the name, script tag and fallback verdict of a worker validator. Attachments to detection entries are owned from the entry side and are not affected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_WorkerValidatorWrite"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "Invoice scorer",
    "script_tag": "0123456789abcdef0123456789abcdef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a worker validator status — cloudflare.dlp-validators-get-worker-validator-status

Reports whether the validator's Worker can be used. Returns worker_not_found if the Worker cannot be found, and worker_error if the Worker does not have a valid validation entrypoint or is returning incorrect responses.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a validator — cloudflare.dlp-validators-get-validator

Fetches a validator of any kind by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.validator_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "validator_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DLS prefix bindings for an account — cloudflare.publiclistprefixbindings

List the BYOIP prefix bindings configured for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_account_identifier"
query object Optional additionalProperties: false
query.cursor string Optional Opaque token for cursor-based pagination. Omit for the first page. Pass the value from a previous response to fetch the next page.
query.per_page integer Optional default: 25; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a DLS prefix binding — cloudflare.publiccreateprefixbinding

Bind a CIDR from a BYOIP prefix to a region.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_account_identifier"
body — Required $ref: "#/definitions/dls_CreatePrefixBindingInput"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "prefix_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cidr": "10.0.1.0/24",
    "region_key": "eu"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a DLS prefix binding — cloudflare.publicdeleteprefixbinding

Delete a BYOIP prefix binding.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_account_identifier"
path.binding_id string Required Unique identifier for the prefix binding.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "binding_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a DLS prefix binding — cloudflare.publicgetprefixbinding

Retrieve a single BYOIP prefix binding by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_account_identifier"
path.binding_id string Required Unique identifier for the prefix binding.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "binding_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a DLS prefix binding — cloudflare.publicpatchprefixbinding

Update the region of an existing BYOIP prefix binding.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_account_identifier"
path.binding_id string Required Unique identifier for the prefix binding.
body — Required $ref: "#/definitions/dls_UpdatePrefixBindingInput"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "binding_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "body": {
    "region_key": "eu"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DLS regions for an account — cloudflare.publiclistregions

List the DLS regions (managed and custom) available to an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_account_identifier"
query object Optional additionalProperties: false
query.cursor string Optional Opaque token for cursor-based pagination. Omit for the first page. Pass the value from a previous response to fetch the next page.
query.per_page integer Optional default: 25; minimum: 1; maximum: 100
query.type string Optional Filter regions by type. Omit to return all regions. enum: ["managed","custom"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a DLS region — cloudflare.publicgetregion

Retrieve a single DLS region (managed or custom) by ID or region key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dls_account_identifier"
path.region_id string Required UUID of the region (custom or managed) or region_key of a managed region. maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "region_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DNS Firewall Clusters — cloudflare.dns-firewall-list-dns-firewall-clusters

List DNS Firewall clusters for an account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-firewall_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results default: 1; minimum: 1
query.per_page number Optional Number of clusters per page default: 20; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete DNS Firewall Cluster — cloudflare.dns-firewall-delete-dns-firewall-cluster

Delete a DNS Firewall cluster

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dns_firewall_id — Required $ref: "#/definitions/dns-firewall_identifier"
path.account_id — Required $ref: "#/definitions/dns-firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dns_firewall_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

DNS Firewall Cluster Details — cloudflare.dns-firewall-dns-firewall-cluster-details

Show a single DNS Firewall cluster for an account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dns_firewall_id — Required $ref: "#/definitions/dns-firewall_identifier"
path.account_id — Required $ref: "#/definitions/dns-firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dns_firewall_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update DNS Firewall Cluster — cloudflare.dns-firewall-update-dns-firewall-cluster

Modify the configuration of a DNS Firewall cluster

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dns_firewall_id — Required $ref: "#/definitions/dns-firewall_identifier"
path.account_id — Required $ref: "#/definitions/dns-firewall_identifier"
body — Required $ref: "#/definitions/dns-firewall_dns-firewall-cluster-patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dns_firewall_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Show DNS Firewall Cluster Reverse DNS — cloudflare.dns-firewall-show-dns-firewall-cluster-reverse-dns

Show reverse DNS configuration (PTR records) for a DNS Firewall cluster

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dns_firewall_id — Required $ref: "#/definitions/dns-firewall_identifier"
path.account_id — Required $ref: "#/definitions/dns-firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dns_firewall_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update DNS Firewall Cluster Reverse DNS — cloudflare.dns-firewall-update-dns-firewall-cluster-reverse-dns

Update reverse DNS configuration (PTR records) for a DNS Firewall cluster

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dns_firewall_id — Required $ref: "#/definitions/dns-firewall_identifier"
path.account_id — Required $ref: "#/definitions/dns-firewall_identifier"
body — Required $ref: "#/definitions/dns-firewall_dns-firewall-reverse-dns-patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dns_firewall_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DNS Record Usage for Account — cloudflare.dns-records-for-an-account-get-usage

Get the current DNS record usage and quota for an account. May include internal DNS usage and quota.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-records_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Show DNS Settings — cloudflare.dns-settings-for-an-account-list-dns-settings

Show DNS settings for an account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update DNS Settings — cloudflare.dns-settings-for-an-account-update-dns-settings

Update DNS settings for an account

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
body — Required $ref: "#/definitions/dns-settings_account_settings_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Custom Nameserver Sets — cloudflare.dns-settings-for-an-account-list-custom-nameserver-sets

Lists an account's Custom Nameserver Sets. For details, refer to Nameserver sets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
query object Optional additionalProperties: false
query.page — Optional $ref: "#/definitions/dns-settings_page"
query.per_page integer Optional Number of results per page. default: 100; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Custom Nameserver Set — cloudflare.dns-settings-for-an-account-create-custom-nameserver-set

Creates a named Custom Nameserver Set. Only the customer-defined name can be changed later. To change nameservers or addresses, create a new set, move any zone assignments, and delete the old set. For details, refer to Nameserver sets.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
body — Required $ref: "#/definitions/dns-settings_nameserver-set-create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Production nameservers",
    "nameservers": [
      {
        "name": "ns1.example.com"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Custom Nameserver Set — cloudflare.dns-settings-for-an-account-delete-custom-nameserver-set

Deletes an unassigned Custom Nameserver Set. For details, refer to Nameserver sets.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
path.nameserver_set_id — Required $ref: "#/definitions/dns-settings_nameserver-set-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "nameserver_set_id": "0123456789abcdef0123456789abcdef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Custom Nameserver Set — cloudflare.dns-settings-for-an-account-get-custom-nameserver-set

Gets a Custom Nameserver Set owned by an account. For details, refer to Nameserver sets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
path.nameserver_set_id — Required $ref: "#/definitions/dns-settings_nameserver-set-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "nameserver_set_id": "0123456789abcdef0123456789abcdef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Custom Nameserver Set — cloudflare.dns-settings-for-an-account-update-custom-nameserver-set

Renames a Custom Nameserver Set owned by the account. Only name may be supplied; immutable and unknown fields are rejected even if unchanged. An empty object or the existing name is a successful no-op. Requires the account-scoped creation entitlements for the existing set.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
path.nameserver_set_id — Required $ref: "#/definitions/dns-settings_nameserver-set-id"
body — Required $ref: "#/definitions/dns-settings_nameserver-set-patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "nameserver_set_id": "0123456789abcdef0123456789abcdef"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Internal DNS Views — cloudflare.dns-views-for-an-account-list-internal-dns-views

List DNS Internal Views for an Account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
query object Optional additionalProperties: false
query.name string Optional Exact value of the DNS view name. This is a convenience alias for name.exact.
query.name.exact string Optional Exact value of the DNS view name.
query.name.contains string Optional Substring of the DNS view name.
query.name.startswith string Optional Prefix of the DNS view name.
query.name.endswith string Optional Suffix of the DNS view name.
query.zone_id string Optional A zone ID that exists in the zones list for the view.
query.zone_name string Optional A zone name that exists in the zones list for the view.
query.match — Optional $ref: "#/definitions/dns-settings_match"
query.page — Optional $ref: "#/definitions/dns-settings_page"
query.per_page — Optional $ref: "#/definitions/dns-settings_per_page"
query.order — Optional $ref: "#/definitions/dns-settings_order"
query.direction — Optional $ref: "#/definitions/dns-settings_direction"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Internal DNS View — cloudflare.dns-views-for-an-account-create-internal-dns-views

Create Internal DNS View for an account

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
body — Required $ref: "#/definitions/dns-settings_dns-view-post"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "my view",
    "zones": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Internal DNS View — cloudflare.dns-views-for-an-account-delete-internal-dns-view

Delete an existing Internal DNS View

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
path.view_id — Required $ref: "#/definitions/dns-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "view_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

DNS Internal View Details — cloudflare.dns-views-for-an-account-get-internal-dns-view

Get DNS Internal View

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
path.view_id — Required $ref: "#/definitions/dns-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "view_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Internal DNS View — cloudflare.dns-views-for-an-account-update-internal-dns-view

Update an existing Internal DNS View

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/dns-settings_identifier"
path.view_id — Required $ref: "#/definitions/dns-settings_identifier"
body — Required $ref: "#/definitions/dns-settings_dns-view-patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "view_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get monthly report — cloudflare.email_security_get_monthly_report

Returns an aggregated monthly email security report including detections, dispositions, and policy activity for the trailing 12 months.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search email messages — cloudflare.email_security_investigate

Returns information for each email that matches the provided search parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.start string Optional The beginning of the search date range. Defaults to now - 30 days. Must not be in the future. format: "date-time"
query.end string Optional The end of the search date range. Defaults to now. format: "date-time"
query.query string Optional Space-delimited term matched case-insensitively against message metadata — sender, recipient, subject, attachment names and hashes, and message ID.
query.detections_only boolean Optional Whether to include only detections in search results. default: true
query.final_disposition string Optional Dispositions to filter by. enum: ["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"]
query.metric string Optional Metric to aggregate the results by.
query.message_action string Optional Message actions to filter by. enum: ["PREVIEW","QUARANTINE_RELEASED","MOVED"]
query.recipient string Optional Filter by recipient. Matches an email address or a domain.
query.sender string Optional Filter by sender. Matches an email address or a domain.
query.smtp_helo_ip string Optional Matches messages whose SMTP HELO server IP address equals this value.
query.alert_id string Optional Filter by alert ID.
query.domain string Optional Filter by a domain found in the email — sender domain, recipient domain, or a domain in a link.
query.message_id string Optional Filter by the RFC 5322 Message-ID header.
query.subject string Optional Search for messages containing individual keywords in any order within the subject.
query.delivery_status — Optional Delivery status to filter by. $ref: "#/definitions/email-security_MessageDeliveryStatus"
query.cursor string Optional Pagination cursor from the previous response's result_info.
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.page integer | null Optional Deprecated: Use cursor pagination instead. End of life: November 1, 2026. default: 1; minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List bulk action jobs — cloudflare.email_security_get_bulk_jobs

Returns a paginated list of bulk action jobs for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.action_type string Optional Filter jobs by the action they perform. enum: ["MOVE","RELEASE"]
query.status — Optional Filter jobs by their processing status. $ref: "#/definitions/email-security_BulkJobStatus"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a bulk action job — cloudflare.email_security_create_bulk_job

Creates a new bulk action job to move or release messages that match the provided search parameters. To move or release an explicit list of known messages instead of a search, use the move or release endpoints.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_BulkActionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "action": "MOVE",
    "search_params": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a bulk action job — cloudflare.email_security_delete_bulk_job

Deletes the job, removing it from all list and detail endpoints. Only jobs in a terminal state (COMPLETED, CANCELLED, or FAILED) can be deleted. To stop an in-progress job without removing it, use the cancel endpoint instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.job_id — Required Identifier of the bulk action job. $ref: "#/definitions/email-security_BulkJobId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "job_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get bulk action job details — cloudflare.email_security_get_bulk_job

Returns the status and details of a specific bulk action job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.job_id — Required Identifier of the bulk action job. $ref: "#/definitions/email-security_BulkJobId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "job_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a bulk action job — cloudflare.email_security_cancel_bulk_job

Cancels the job, marking it as cancelled and stopping any pending message processing. The job record remains visible in list and detail endpoints.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.job_id — Required Identifier of the bulk action job to cancel. $ref: "#/definitions/email-security_BulkJobId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "job_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List messages for a bulk action job — cloudflare.email_security_get_bulk_job_messages

Returns the individual messages associated with a bulk action job, including their processing status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.job_id — Required Identifier of the bulk action job whose messages to list. $ref: "#/definitions/email-security_BulkJobId"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.status — Optional Filter the job's messages by their processing status. $ref: "#/definitions/email-security_BulkActionMessageStatus"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "job_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Move messages — cloudflare.email_security_post_bulk_move

Moves one or more messages to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration. Operates on an explicit list of messages; to move all messages matching a search, create a bulk action job instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.destination — Required $ref: "#/definitions/email-security_MailboxDestination"
body.expected_disposition string | null Optional Nonfunctional field. End of life: December 1, 2026.
body.expected_disposition — Optional allOf[1]; $ref: "#/definitions/email-security_DispositionLabel"
body.ids array Required List of message IDs to move. minItems: 1; maxItems: 1000
body.ids[] — Optional $ref: "#/definitions/email-security_InvestigateId"
body.postfix_ids array Optional Deprecated, use ids instead. End of life: November 1, 2026.
body.postfix_ids[] — Optional $ref: "#/definitions/email-security_PostfixId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination": "Inbox",
    "ids": [
      "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate preview for a non-detection message — cloudflare.email_security_post_preview

Generates a preview image for a message that was not flagged as a detection. The message is rendered from the copy in the recipient's mailbox, so this requires an active integration and only works while the message is still in the recipient's inbox. Returns a base64-encoded PNG screenshot of the email body. For messages with a detection, use the detection preview endpoint instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.id — Required $ref: "#/definitions/email-security_InvestigateId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Release messages from quarantine — cloudflare.email_security_post_release

Delivers one or more quarantined messages to their intended recipients, for cases where a message was incorrectly quarantined. Operates on an explicit list of messages; to release all messages matching a search, create a bulk action job instead. The response includes delivery status for each recipient.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.ids array Required Investigate IDs of the messages to release. minItems: 1
body.ids[] — Optional $ref: "#/definitions/email-security_InvestigateId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "ids": [
      "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get message details — cloudflare.email_security_get_message

Retrieves comprehensive details for a specific email message including headers, recipients, sender information, and current quarantine status. Use the investigate_id from search results to fetch detailed information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.investigate_id — Required $ref: "#/definitions/email-security_InvestigateId"
query object Optional additionalProperties: false
query.submission boolean Optional When true, search the submissions datastore only. When false or omitted, search the regular datastore only.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "investigate_id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List post-delivery actions for a message — cloudflare.email_security_get_message_action_log

Returns the list of post-delivery actions (moves, quarantine releases, previews, etc.) that have been applied to a specific email message.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.investigate_id — Required $ref: "#/definitions/email-security_InvestigateId"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "investigate_id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get message detection details — cloudflare.email_security_get_message_detections

Returns detection details such as threat categories and sender information for messages with a detection.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.investigate_id — Required $ref: "#/definitions/email-security_InvestigateId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "investigate_id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Move a message — cloudflare.email_security_post_message_move

Moves a single message to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.investigate_id — Required $ref: "#/definitions/email-security_InvestigateId"
body object Required
body.destination — Required $ref: "#/definitions/email-security_MailboxDestination"
body.expected_disposition string | null Optional Nonfunctional field. End of life: December 1, 2026.
body.expected_disposition — Optional allOf[1]; $ref: "#/definitions/email-security_DispositionLabel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "investigate_id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  },
  "body": {
    "destination": "Inbox"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get preview for a detection — cloudflare.email_security_get_message_preview

Returns a preview of the message body as a base64-encoded PNG image for any message with a detection. For messages without a detection, use the non-detection preview endpoint instead.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.investigate_id — Required $ref: "#/definitions/email-security_InvestigateId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "investigate_id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get raw email content — cloudflare.email_security_get_message_raw

Returns the raw EML content of any message with a detection.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.investigate_id — Required $ref: "#/definitions/email-security_InvestigateId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "investigate_id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get email trace — cloudflare.email_security_get_message_trace

Retrieves delivery and processing trace information for an email message. Shows the delivery path, retraction history, and move operations performed on the message. Useful for debugging delivery issues.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.investigate_id — Required $ref: "#/definitions/email-security_InvestigateId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "investigate_id": "4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List PhishGuard reports — cloudflare.email_security_get_phishguard_reports

Retrieves PhishGuard security alert reports for a specified date range. Reports include detected threats, dispositions, and contextual information. Use for security monitoring and threat analysis.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.start string Optional Start of the time range (RFC3339). Takes precedence over from_date. format: "date-time"
query.end string Optional End of the time range (RFC3339). Takes precedence over to_date. format: "date-time"
query.from_date string Optional Deprecated, use start instead. Start date in YYYY-MM-DD format. format: "date"
query.to_date string Optional Deprecated, use end instead. End date in YYYY-MM-DD format. format: "date"
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List email allow policies — cloudflare.email_security_list_allow_policies

Returns a paginated list of email allow policies. These policies exempt matching emails from security detection, allowing them to bypass disposition actions. Supports filtering by pattern type and policy attributes.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.search string Optional Search term for filtering records. Behavior may change.
query.order string Optional Field to sort by. enum: ["pattern","created_at"]
query.direction string Optional The sorting direction. enum: ["asc","desc"]
query.is_exempt_recipient boolean Optional Filter to show only policies where messages to the recipient bypass all detections.
query.is_trusted_sender boolean Optional Filter to show only policies where messages from the sender bypass all detections and link following.
query.is_acceptable_sender boolean Optional Filter to show only policies where messages from the sender are exempted from Spam, Spoof, and Bulk dispositions (not Malicious or Suspicious).
query.verify_sender boolean Optional Filter to show only policies that enforce DMARC, SPF, or DKIM authentication.
query.pattern_type — Optional Filter by pattern type.
query.pattern_type — Optional allOf[1]; $ref: "#/definitions/email-security_PatternType"
query.pattern string Optional Filter by exact pattern value.
query.expired boolean Optional Filter to return only expired policies (true) or only policies that still apply (false). Omit to return both.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create email allow policy — cloudflare.email_security_create_allow_policy

Creates a new allow policy that exempts matching emails from security detections. Use with caution as this bypasses email security scanning. Policies can match on sender patterns and apply to specific detections or all detections.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateAllowPolicy"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "is_exempt_recipient": false,
    "is_trusted_sender": true,
    "is_acceptable_sender": false,
    "pattern": "[email protected]",
    "is_regex": false,
    "verify_sender": true,
    "pattern_type": "EMAIL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch allow policy operations — cloudflare.email_security_batch_allow_policies

Executes multiple allow policy operations atomically: delete, partially update, replace, and create allow policies in a single request. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.deletes array Required IDs of the allow policies to delete. maxItems: 1000
body.deletes[] object Optional
body.deletes[].id — Required $ref: "#/definitions/email-security_AllowPolicyId"
body.patches array Required Partial updates to apply — each entry carries the policy's ID and only the fields to change. maxItems: 1000
body.patches[] — Optional
body.patches[] — Optional allOf[1]; $ref: "#/definitions/email-security_UpdateAllowPolicy"
body.patches[] object Optional allOf[2]
body.patches[].id — Required allOf[2]
body.patches[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_AllowPolicyId"
body.posts array Required Allow policies to create. maxItems: 1000
body.posts[] — Optional $ref: "#/definitions/email-security_CreateAllowPolicy"
body.puts array Required Full replacements to apply — each entry carries the policy's ID and every field of its new value. maxItems: 1000
body.puts[] — Optional
body.puts[] — Optional allOf[1]; $ref: "#/definitions/email-security_CreateAllowPolicy"
body.puts[] object Optional allOf[2]
body.puts[].id — Required allOf[2]
body.puts[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_AllowPolicyId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "deletes": [],
    "patches": [],
    "puts": [],
    "posts": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an email allow policy — cloudflare.email_security_delete_allow_policy

Removes an allow policy. After deletion, emails matching this pattern will be subject to normal security scanning and disposition actions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.policy_id — Required $ref: "#/definitions/email-security_AllowPolicyId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an email allow policy — cloudflare.email_security_get_allow_policy

Retrieves details for a specific allow policy including its pattern, dispositions that are exempted, and whether it applies to all detections.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.policy_id — Required $ref: "#/definitions/email-security_AllowPolicyId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace an email allow policy — cloudflare.email_security_replace_allow_policy

Replaces an existing allow policy in full. Unlike PATCH, every field is taken from the request body, so optional fields that are omitted are reset rather than left untouched. Use this when managing policies declaratively.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.policy_id — Required $ref: "#/definitions/email-security_AllowPolicyId"
body — Required $ref: "#/definitions/email-security_CreateAllowPolicy"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "is_exempt_recipient": false,
    "is_trusted_sender": true,
    "is_acceptable_sender": false,
    "pattern": "[email protected]",
    "is_regex": false,
    "verify_sender": true,
    "pattern_type": "EMAIL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List blocked email senders — cloudflare.email_security_list_blocked_senders

Returns a paginated list of blocked email sender patterns. These patterns prevent emails from matching senders from being delivered. Supports filtering by pattern type and searching across patterns.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.search string Optional Search term for filtering records. Behavior may change.
query.order string Optional Field to sort by. enum: ["pattern","created_at"]
query.direction string Optional The sorting direction. enum: ["asc","desc"]
query.pattern_type — Optional Filter by pattern type.
query.pattern_type — Optional allOf[1]; $ref: "#/definitions/email-security_PatternType"
query.pattern string Optional Filter by pattern value.
query.expired boolean Optional Filter to return only expired patterns (true) or only patterns that still apply (false). Omit to return both.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create blocked email sender — cloudflare.email_security_create_blocked_sender

Creates a new blocked sender pattern. Emails matching this pattern will be blocked from delivery. Patterns can be email addresses, domains, or IP addresses, and support regular expressions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateBlockedSender"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "pattern": "[email protected]",
    "is_regex": false,
    "pattern_type": "EMAIL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch blocked sender operations — cloudflare.email_security_batch_blocked_senders

Executes multiple blocked sender operations atomically: delete, partially update, replace, and create blocked sender patterns in a single request. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.deletes array Required IDs of the blocked sender patterns to delete. maxItems: 1000
body.deletes[] object Optional
body.deletes[].id — Required $ref: "#/definitions/email-security_BlockedSenderId"
body.patches array Required Partial updates to apply — each entry carries the pattern's ID and only the fields to change. maxItems: 1000
body.patches[] — Optional
body.patches[] — Optional allOf[1]; $ref: "#/definitions/email-security_UpdateBlockedSender"
body.patches[] object Optional allOf[2]
body.patches[].id — Required allOf[2]
body.patches[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_BlockedSenderId"
body.posts array Required Blocked sender patterns to create. maxItems: 1000
body.posts[] — Optional $ref: "#/definitions/email-security_CreateBlockedSender"
body.puts array Required Full replacements to apply — each entry carries the pattern's ID and every field of its new value. maxItems: 1000
body.puts[] — Optional
body.puts[] — Optional allOf[1]; $ref: "#/definitions/email-security_CreateBlockedSender"
body.puts[] object Optional allOf[2]
body.puts[].id — Required allOf[2]
body.puts[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_BlockedSenderId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "deletes": [],
    "patches": [],
    "puts": [],
    "posts": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a blocked email sender — cloudflare.email_security_delete_blocked_sender

Removes a blocked sender pattern. After deletion, emails from this sender will no longer be automatically blocked based on this rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.pattern_id — Required $ref: "#/definitions/email-security_BlockedSenderId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a blocked email sender — cloudflare.email_security_get_blocked_sender

Retrieves details for a specific blocked sender pattern including its pattern type, value, and metadata.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.pattern_id — Required $ref: "#/definitions/email-security_BlockedSenderId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace a blocked email sender — cloudflare.email_security_replace_blocked_sender

Replaces an existing blocked sender pattern in full. Unlike PATCH, every field is taken from the request body, so optional fields that are omitted are reset rather than left untouched. Use this when managing blocked senders declaratively.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.pattern_id — Required $ref: "#/definitions/email-security_BlockedSenderId"
body — Required $ref: "#/definitions/email-security_CreateBlockedSender"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "pattern": "[email protected]",
    "is_regex": false,
    "pattern_type": "EMAIL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List content policies — cloudflare.email_security_list_content_policies

Returns a paginated list of content policies. These policies match against the subject or body of emails using a pattern. Supports filtering by name or enabled status, and searching across name and pattern fields.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.search string Optional Search term for filtering records. Behavior may change.
query.order string Optional Field to sort by. enum: ["name","created_at"]
query.direction string Optional The sorting direction. enum: ["asc","desc"]
query.enabled boolean Optional Filter by enabled status.
query.name string Optional Filter by exact policy name.
query.expired boolean Optional Filter to return only expired policies (true) or only policies that still apply (false). Omit to return both.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a content policy — cloudflare.email_security_create_content_policy

Creates a new content policy. Emails whose subject or body matches the pattern will be subject to the configured action.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateContentPolicy"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Block phishing keywords",
    "pattern": "urgent.*verify.*account",
    "targets": [
      "SUBJECT"
    ],
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch content policy operations — cloudflare.email_security_batch_content_policies

Executes multiple content policy operations atomically: delete, partially update, replace, and create content policies in a single request. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.deletes array Required IDs of the content policies to delete. maxItems: 1000
body.deletes[] object Optional
body.deletes[].id — Required $ref: "#/definitions/email-security_ContentPolicyId"
body.patches array Required Partial updates to apply — each entry carries the policy's ID and only the fields to change. maxItems: 1000
body.patches[] — Optional
body.patches[] — Optional allOf[1]; $ref: "#/definitions/email-security_UpdateContentPolicy"
body.patches[] object Optional allOf[2]
body.patches[].id — Required allOf[2]
body.patches[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_ContentPolicyId"
body.posts array Required Content policies to create. maxItems: 1000
body.posts[] — Optional $ref: "#/definitions/email-security_CreateContentPolicy"
body.puts array Required Full replacements to apply — each entry carries the policy's ID and every field of its new value. maxItems: 1000
body.puts[] — Optional
body.puts[] — Optional allOf[1]; $ref: "#/definitions/email-security_CreateContentPolicy"
body.puts[] object Optional allOf[2]
body.puts[].id — Required allOf[2]
body.puts[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_ContentPolicyId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "deletes": [],
    "patches": [],
    "puts": [],
    "posts": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a content policy — cloudflare.email_security_delete_content_policy

Removes a content policy. After deletion, emails will no longer be evaluated against this pattern.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.policy_id — Required $ref: "#/definitions/email-security_ContentPolicyId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a content policy — cloudflare.email_security_get_content_policy

Retrieves details for a specific content policy including its pattern, targets, and metadata.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.policy_id — Required $ref: "#/definitions/email-security_ContentPolicyId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List protected email domains — cloudflare.email_security_list_domains

Returns a paginated list of email domains protected by Email Security. Includes domain configuration, delivery modes, and authorization status. Supports filtering by delivery mode and integration ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.search string Optional Search term for filtering records. Behavior may change.
query.order string Optional Field to sort by. enum: ["domain","created_at"]
query.direction string Optional The sorting direction. enum: ["asc","desc"]
query.allowed_delivery_mode — Optional Delivery mode to filter by. $ref: "#/definitions/email-security_DeliveryMode"
query.domain array Optional Domain names to filter by.
query.domain[] string Optional
query.active_delivery_mode — Optional Currently active delivery mode to filter by. $ref: "#/definitions/email-security_DeliveryMode"
query.integration_id string Optional Integration ID to filter by. format: "uuid"
query.status — Optional Filters response to domains with the provided status. $ref: "#/definitions/email-security_DomainStatus"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a new email domain — cloudflare.email_security_create_domains

Protects a new email domain by adding it to Email Security. Accepts a flat configuration object covering all delivery modes. Returns the newly created domain configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateDomain"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "domain": "example",
    "allowed_delivery_modes": [
      "DIRECT"
    ],
    "ip_restrictions": [
      "192.0.2.0/24",
      "2001:db8::/32"
    ],
    "drop_dispositions": [],
    "regions": [
      "GLOBAL"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch domain operations — cloudflare.email_security_batch_domains

Executes multiple domain operations in a single request. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.deletes array Required IDs of the domains to remove protection from. maxItems: 1000
body.deletes[] object Optional
body.deletes[].id — Required $ref: "#/definitions/email-security_DomainId"
body.patches array Required Partial updates to apply — each entry carries the domain's ID and only the fields to change. maxItems: 1000
body.patches[] — Optional
body.patches[] — Optional allOf[1]; $ref: "#/definitions/email-security_UpdateDomain"
body.patches[] object Optional allOf[2]
body.patches[].id — Required allOf[2]; $ref: "#/definitions/email-security_DomainId"
body.posts array Required Domains to add protection for. maxItems: 1000
body.posts[] — Optional $ref: "#/definitions/email-security_CreateDomain"
body.puts array Required Full replacements to apply — each entry carries the domain's ID and every field of its new value. maxItems: 1000
body.puts[] — Optional
body.puts[] — Optional allOf[1]; $ref: "#/definitions/email-security_ReplaceDomain"
body.puts[] object Optional allOf[2]
body.puts[].id — Required allOf[2]; $ref: "#/definitions/email-security_DomainId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "deletes": [],
    "patches": [],
    "puts": [],
    "posts": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unprotect an email domain — cloudflare.email_security_delete_domain

Removes email security protection from a domain. After deletion, emails for this domain will no longer be processed by Email Security. This action cannot be undone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.domain_id — Required $ref: "#/definitions/email-security_DomainId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an email domain — cloudflare.email_security_get_domain

Retrieves detailed information for a specific protected email domain including its delivery configuration, SPF/DMARC status, and authorization state.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.domain_id — Required $ref: "#/definitions/email-security_DomainId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an email domain — cloudflare.email_security_update_domain

Updates configuration for a protected email domain. Only provided fields will be modified. Changes affect delivery mode, security settings, and regional processing.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.domain_id — Required $ref: "#/definitions/email-security_DomainId"
body — Required $ref: "#/definitions/email-security_UpdateDomain"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace an email domain — cloudflare.email_security_replace_domain

Replaces all mutable fields of a protected email domain in a single atomic operation. Unlike PATCH, all non-computed fields are required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.domain_id — Required $ref: "#/definitions/email-security_DomainId"
body — Required $ref: "#/definitions/email-security_ReplaceDomain"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "allowed_delivery_modes": [
      "DIRECT"
    ],
    "ip_restrictions": [
      "192.0.2.0/24",
      "2001:db8::/32"
    ],
    "drop_dispositions": [],
    "regions": [
      "GLOBAL"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get domain verification details — cloudflare.email_security_get_domain_verification

Returns the DNS TXT record information when the domain ownership isn't verified through Cloudflare zone ownership or CASB integration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.domain_id — Required $ref: "#/definitions/email-security_DomainId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List impersonation registry entries — cloudflare.email_security_list_impersonation_registry

Returns a paginated list of protected identities in the impersonation registry. These entries define identities and email addresses to protect from impersonation attacks. Can be manually added or automatically synced from directory integrations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.search string Optional Search term for filtering records. Behavior may change.
query.order string Optional Field to sort by. enum: ["name","email","created_at"]
query.direction string Optional The sorting direction. enum: ["asc","desc"]
query.provenance — Optional $ref: "#/definitions/email-security_Provenance"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create impersonation registry entry — cloudflare.email_security_create_impersonation_registry

Creates a new entry in the impersonation registry to protect against impersonation. Emails attempting to impersonate this identity will be flagged. Supports regex patterns for flexible email matching.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateImpersonationRegistry"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "John Doe",
    "email": "[email protected]",
    "is_email_regex": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an impersonation registry entry — cloudflare.email_security_delete_impersonation_registry

Removes an entry from the impersonation registry. After deletion, this identity will no longer be protected from impersonation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.impersonation_registry_id — Required $ref: "#/definitions/email-security_ImpersonationRegistryId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "impersonation_registry_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an impersonation registry entry — cloudflare.email_security_get_impersonation_registry

Retrieves details for a specific impersonation registry entry including the protected identity, email pattern, and synchronization source if directory-synced.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.impersonation_registry_id — Required $ref: "#/definitions/email-security_ImpersonationRegistryId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "impersonation_registry_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List sending domain restrictions — cloudflare.email_security_list_sending_domain_restrictions

Returns a paginated list of sending domain restrictions. These restrictions enforce TLS requirements for emails from specific domains. Mail without TLS from restricted domains will be dropped unless the subdomain is in the exclude list. Supports sorting and searching.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.search string Optional Search term for filtering records. Behavior may change.
query.order string Optional Field to sort by. enum: ["domain","created_at"]
query.direction string Optional The sorting direction. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a sending domain restriction — cloudflare.email_security_create_sending_domain_restriction

Creates a new sending domain restriction to enforce TLS requirements for a domain. Emails without TLS from this domain will be dropped unless the subdomain is in the exclude list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateSendingDomainRestriction"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "domain": "example.com",
    "exclude": [
      "subdomain.example.com"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch sending domain restriction operations — cloudflare.email_security_batch_sending_domain_restrictions

Executes multiple delete operations on sending domain restrictions atomically. All operations succeed or fail together as a transaction. Currently only supports batch deletion. Removes TLS enforcement requirements for the specified domains.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.deletes array Required IDs of the sending domain restrictions to delete. maxItems: 1000
body.deletes[] object Optional
body.deletes[].id — Required $ref: "#/definitions/email-security_SendingDomainRestrictionId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "deletes": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a sending domain restriction — cloudflare.email_security_delete_sending_domain_restriction

Removes a sending domain restriction. After deletion, TLS will no longer be enforced for emails from this domain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.sending_domain_restriction_id — Required $ref: "#/definitions/email-security_SendingDomainRestrictionId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sending_domain_restriction_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a sending domain restriction — cloudflare.email_security_get_sending_domain_restriction

Retrieves details for a specific sending domain restriction including the domain requiring TLS and any excluded subdomains exempt from the TLS requirement.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.sending_domain_restriction_id — Required $ref: "#/definitions/email-security_SendingDomainRestrictionId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sending_domain_restriction_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List trusted email domains — cloudflare.email_security_list_trusted_domains

Returns a paginated list of trusted domain patterns. Trusted domains prevent false positives for recently registered domains and lookalike domain detections. Patterns can use regular expressions for flexible matching.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000
query.search string Optional Search term for filtering records. Behavior may change.
query.order string Optional Field to sort by. enum: ["pattern","created_at"]
query.direction string Optional The sorting direction. enum: ["asc","desc"]
query.is_recent boolean Optional Filter to show only recently registered domains that are trusted to prevent triggering Suspicious or Malicious dispositions.
query.is_similarity boolean Optional Filter to show only proximity domains (partner or approved domains with similar spelling to connected domains) that prevent Spoof dispositions.
query.pattern string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create trusted email domain — cloudflare.email_security_create_trusted_domain

Creates a new trusted domain pattern. Use for partner domains or approved senders that should bypass recent domain registration and similarity checks. Configure whether it prevents recent domain or spoof dispositions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateTrustedDomain"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "pattern": "example.com",
    "is_regex": false,
    "is_recent": true,
    "is_similarity": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch trusted domain operations — cloudflare.email_security_batch_trusted_domains

Executes multiple trusted domain operations atomically: delete, partially update, replace, and create trusted domain patterns in a single request. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.deletes array Required IDs of the trusted domain patterns to delete. maxItems: 1000
body.deletes[] object Optional
body.deletes[].id — Required $ref: "#/definitions/email-security_TrustedDomainId"
body.patches array Required Partial updates to apply — each entry carries the pattern's ID and only the fields to change. maxItems: 1000
body.patches[] — Optional
body.patches[] — Optional allOf[1]; $ref: "#/definitions/email-security_UpdateTrustedDomain"
body.patches[] object Optional allOf[2]
body.patches[].id — Required allOf[2]
body.patches[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_TrustedDomainId"
body.posts array Required Trusted domain patterns to create. maxItems: 1000
body.posts[] — Optional $ref: "#/definitions/email-security_CreateTrustedDomain"
body.puts array Required Full replacements to apply — each entry carries the pattern's ID and every field of its new value. maxItems: 1000
body.puts[] — Optional
body.puts[] — Optional allOf[1]; $ref: "#/definitions/email-security_CreateTrustedDomain"
body.puts[] object Optional allOf[2]
body.puts[].id — Required allOf[2]
body.puts[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_TrustedDomainId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "deletes": [],
    "patches": [],
    "puts": [],
    "posts": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a trusted email domain — cloudflare.email_security_delete_trusted_domain

Removes a trusted domain pattern. After deletion, emails from this domain will be subject to normal recent domain and similarity checks.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.trusted_domain_id — Required $ref: "#/definitions/email-security_TrustedDomainId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "trusted_domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a trusted email domain — cloudflare.email_security_get_trusted_domain

Retrieves details for a specific trusted domain pattern including its pattern value, whether it uses regex matching, and which detection types it affects.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.trusted_domain_id — Required $ref: "#/definitions/email-security_TrustedDomainId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "trusted_domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace a trusted email domain — cloudflare.email_security_replace_trusted_domain

Replaces an existing trusted domain in full. Unlike PATCH, every field is taken from the request body, so optional fields that are omitted are reset rather than left untouched. Use this when managing trusted domains declaratively.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.trusted_domain_id — Required $ref: "#/definitions/email-security_TrustedDomainId"
body — Required $ref: "#/definitions/email-security_CreateTrustedDomain"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "trusted_domain_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "pattern": "example.com",
    "is_regex": false,
    "is_recent": true,
    "is_similarity": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List URL ignore patterns — cloudflare.email_security_list_url_ignore_patterns

Returns a paginated list of URL rewrite ignore patterns for the account. URLs matching these patterns will not be rewritten.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a URL ignore pattern — cloudflare.email_security_create_url_ignore_pattern

Creates a new URL rewrite ignore pattern. URLs matching this pattern will not be rewritten.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required $ref: "#/definitions/email-security_CreateUrlIgnorePattern"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "pattern": "https://example\\.com/.*"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch URL ignore pattern operations — cloudflare.email_security_batch_url_ignore_patterns

Executes multiple operations atomically. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body object Required
body.deletes array Required IDs of the URL ignore patterns to delete. maxItems: 1000
body.deletes[] object Optional
body.deletes[].id — Required $ref: "#/definitions/email-security_UrlIgnorePatternId"
body.patches array Required Partial updates to apply — each entry carries the pattern's ID and only the fields to change. maxItems: 1000
body.patches[] — Optional
body.patches[] — Optional allOf[1]; $ref: "#/definitions/email-security_UpdateUrlIgnorePattern"
body.patches[] object Optional allOf[2]
body.patches[].id — Required allOf[2]
body.patches[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_UrlIgnorePatternId"
body.posts array Required URL ignore patterns to create. maxItems: 1000
body.posts[] — Optional $ref: "#/definitions/email-security_CreateUrlIgnorePattern"
body.puts array Required Full replacements to apply — each entry carries the pattern's ID and every field of its new value. maxItems: 1000
body.puts[] — Optional
body.puts[] — Optional allOf[1]; $ref: "#/definitions/email-security_CreateUrlIgnorePattern"
body.puts[] object Optional allOf[2]
body.puts[].id — Required allOf[2]
body.puts[].id — Required allOf[2]; allOf[1]; $ref: "#/definitions/email-security_UrlIgnorePatternId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "deletes": [],
    "patches": [],
    "puts": [],
    "posts": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a URL ignore pattern — cloudflare.email_security_delete_url_ignore_pattern

Removes a URL rewrite ignore pattern. After deletion, URLs matching this pattern will be rewritten again.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.pattern_id — Required $ref: "#/definitions/email-security_UrlIgnorePatternId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a URL ignore pattern — cloudflare.email_security_get_url_ignore_pattern

Returns a single URL rewrite ignore pattern by its identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
path.pattern_id — Required $ref: "#/definitions/email-security_UrlIgnorePatternId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reclassify submissions — cloudflare.email_security_submissions

Returns information for submissions made to reclassify emails. Shows the status, outcome, and disposition changes for reclassification requests made by users or the security team. Useful for tracking false positive/negative reports.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
query object Optional additionalProperties: false
query.start string Optional The beginning of the search date range. Defaults to now - 30 days. format: "date-time"
query.end string Optional The end of the search date range. Defaults to now. format: "date-time"
query.type string Optional Filter by who created the submission — TEAM for security team members or USER for end users. enum: ["TEAM","USER"]
query.submission_id string Optional Filter by a specific submission ID.
query.original_disposition — Optional $ref: "#/definitions/email-security_SubmissionDisposition"
query.requested_disposition — Optional $ref: "#/definitions/email-security_SubmissionDisposition"
query.outcome_disposition — Optional $ref: "#/definitions/email-security_SubmissionDisposition"
query.status string Optional Filter by review status — escalated, reviewed, or unreviewed.
query.query string | null Optional Search term for filtering submissions.
query.escalated_from_user boolean Optional When true, return only submissions that were escalated by an end user (vs. by the security team). When false, return only submissions that were not escalated by an end user. When omitted, no filter is applied.
query.order string Optional Field to sort by. enum: ["submission_id","subject","original_disposition","requested_disposition","outcome_disposition","requested_at"]; default: "requested_at"
query.direction string Optional The sorting direction. enum: ["asc","desc"]
query.page integer Optional Current page within paginated list of results. default: 1; minimum: 1
query.per_page integer Optional The number of results per page. Maximum value is 1000. default: 20; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new submissions — cloudflare.email_security_create_submissions

Submits messages for reclassification or to report missed detections.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier tag. $ref: "#/definitions/email-security_identifier"
body — Required
body object Required oneOf[1]
body.messages array Required oneOf[1]
body.messages[] — Optional oneOf[1]; $ref: "#/definitions/email-security_ReclassificationSubmission"
body.type string Required oneOf[1]; enum: ["reclassification"]
body object Required oneOf[2]
body.messages array Required oneOf[2]
body.messages[] — Optional oneOf[2]; $ref: "#/definitions/email-security_MissedDetectionSubmission"
body.type string Required oneOf[2]; enum: ["missed_detection"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "reclassification",
    "messages": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Email Domain changes — cloudflare.email-domains-changes

Returns retained domain-specific state changes and completed-removal tombstones in a transaction-safe opaque order. The top-level platform field is the current shared gate and must be combined with each domain's state. Store next_cursor after processing every response, and continue immediately while has_more is true. To take a checkpoint, request this operation with modified_since set to the current time, follow has_more to the end, and save the final next_cursor; it replays every change committed after the first of those requests. Initial bootstrap and error 2086 recovery take a checkpoint, list the full inventory, then replay from the saved checkpoint, so changes made during the inventory are not lost. Only a tombstone proves that a domain was removed. Available only to the configured OpenAI pilot account behind a default-off gate; while the gate is off, the pilot account gets 503 with error 2090 and Retry-After, and existing domains are unaffected. Unsupported methods return 405 with error 2091. Authentication failures may use the gateway error envelope.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
query object Optional additionalProperties: false
query.per_page integer Optional Maximum changes to return in one page. default: 20; minimum: 1; maximum: 100
query.cursor string Optional Opaque cursor returned by the previous change page. Omit it for the first page.
query.modified_since string Optional Optional RFC 3339 lower bound for the first request only. Values outside the retained history return error 2086. A value up to one minute ahead of the server clock is read as the current time; a later value returns 400. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Email Domains — cloudflare.email-domains-list

Returns account-scoped domain status. DNS records are omitted unless requested; exact hostname filtering may return several candidates; retain the EmailDomain ID for each enrollment. Available only to the configured OpenAI pilot account behind a default-off gate; while the gate is off, the pilot account gets 503 with error 2090 and Retry-After, and existing domains are unaffected. Unsupported methods return 405 with error 2091. Authentication failures may use the gateway error envelope.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
query object Optional additionalProperties: false
query.per_page integer Optional default: 20; minimum: 1; maximum: 100
query.cursor string Optional Opaque cursor returned by the previous page. Omit it for the first page.
query.hostname string Optional Exact hostname filter for recovering an ambiguous create response.
query.include string Optional Include DNS instructions on each list result. enum: ["dns_records"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an Email Domain — cloudflare.email-domains-create

Creates a candidate and four DNS instructions. Rejects hostnames with more than 16 labels or whose assigned Return-Path exceeds 201 ASCII characters; error 2077 names the hostname rule that failed. Creation follows read-only checks of the saved provider bundle and published exclusion. Hostnames inside an active full Cloudflare DNS zone, including zones under a PSL private suffix such as workers.dev, or held by another enrollment, return the generic hostname conflict error 2083. While an earlier enrollment of this account with the same hostname or client_reference is being deleted, create returns error 2084 with Retry-After set to the expected completion time. No per-domain provider DNS writes occur. Customer DNS observations remain pending and mail remains inactive. Unverified candidates may share a hostname. Supply an account-unique client_reference to retry the same enrollment safely; reuse with a different hostname returns error 2089. A full domain quota returns error 2081 and frees only when domains are deleted or candidates expire, so it is not retryable; the create rate limit returns 429 with error 2088 and Retry-After. Requests rejected before the Cloudflare zone check do not count toward the rate limit. Final public-DNS, namespace protection and runtime readiness are separate gates. Available only to the configured OpenAI pilot account behind a default-off gate; while the gate is off, the pilot account gets 503 with error 2090 and Retry-After, and existing domains are unaffected. Unsupported methods return 405 with error 2091. Authentication failures may use the gateway error envelope.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_email_domain_create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "hostname": "agents.customer.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Email Domain — cloudflare.email-domains-delete

Requires an empty body. Unclaimed, unpublished candidates are removed immediately after token retirement. Acquired or published resources retain deleting state and claims until the deletion worker acknowledges safe revocation and token retirement: deletion completes after the last authorization FWDR may still hold has expired, up to about 31 minutes after the request. Until then the hostname and client_reference cannot be enrolled again. Repeated requests while deleting are idempotent. Retry-After is the expected time until GET returns 404; follow the Location header after it. Available only to the configured OpenAI pilot account behind a default-off gate; while the gate is off, the pilot account gets 503 with error 2090 and Retry-After, and existing domains are unaffected. Unsupported methods return 405 with error 2091. Authentication failures may use the gateway error envelope.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
path.email_domain_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "email_domain_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Email Domain — cloudflare.email-domains-get

Returns domain status and its four assigned DNS records. Shared provider health is reported by the capability states rather than duplicated on each DNS record. Expired unclaimed candidates and completed deletions return 404. Available only to the configured OpenAI pilot account behind a default-off gate; while the gate is off, the pilot account gets 503 with error 2090 and Retry-After, and existing domains are unaffected. Unsupported methods return 405 with error 2091. Authentication failures may use the gateway error envelope.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
path.email_domain_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "email_domain_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Verify an Email Domain — cloudflare.email-domains-verify

Requires an empty body. Schedules an expedited check and coalesces queued or leased work. It does not accept verification results, bypass activation gates, or perform customer DNS checks synchronously. Follow the Location header after Retry-After seconds until verification.observed_at appears or advances beyond the value in this 202 response; status may remain unchanged. Candidate expiry returns 404. A repeat within 30 seconds returns error 2082 with the remaining cooldown in Retry-After. Only a request that schedules a check counts toward the account rate limit, error 2088. Available only to the configured OpenAI pilot account behind a default-off gate; while the gate is off, the pilot account gets 503 with error 2090 and Retry-After, and existing domains are unaffected. Unsupported methods return 405 with error 2091. Authentication failures may use the gateway error envelope.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
path.email_domain_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "email_domain_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List destination addresses — cloudflare.email-routing-destination-addresses-list-destination-addresses

Lists destination addresses configured for Email Routing in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.direction string Optional Sorts results in an ascending or descending order. enum: ["asc","desc"]; default: "asc"
query.verified boolean Optional Filter by verified destination addresses. enum: [true,false]; default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a destination address — cloudflare.email-routing-destination-addresses-create-a-destination-address

Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_create_destination_address_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete destination address — cloudflare.email-routing-destination-addresses-delete-destination-address

Deletes a specific destination address.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.destination_address_identifier — Required $ref: "#/definitions/email_destination_address_identifier"
path.account_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "destination_address_identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a destination address — cloudflare.email-routing-destination-addresses-get-a-destination-address

Gets information for a specific destination email already created.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.destination_address_identifier — Required $ref: "#/definitions/email_destination_address_identifier"
path.account_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "destination_address_identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update destination address — cloudflare.email-routing-destination-addresses-update-destination-address

Updates the status of a specific destination address.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.destination_address_identifier — Required $ref: "#/definitions/email_destination_address_identifier"
path.account_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_update_destination_address_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "destination_address_identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "status": "verified"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account routing rules — cloudflare.email-routing-routing-rules-list-account-routing-rules

Lists existing routing rules across all zones in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.enabled boolean Optional Filter by enabled routing rules. enum: [true,false]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Plan account routing rule changes — cloudflare.email-routing-routing-rules-plan-account-routing-rules

Computes the Email Routing rule changes that would be needed to reconcile a Wrangler-managed desired ruleset. This endpoint is read-only and does not create, update, or delete rules.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_account_rules_plan_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "catch_all_rules": [
      {
        "rule": {
          "actions": [
            {
              "type": "worker",
              "value": [
                "my-worker"
              ]
            }
          ],
          "matchers": [
            {
              "type": "all"
            }
          ]
        },
        "target": "*@example.com"
      }
    ],
    "owner_worker_tag": "a7e6fb77503c41d8a7f3113c6918f10c",
    "rules": [
      {
        "actions": [
          {
            "type": "worker",
            "value": [
              "my-worker"
            ]
          }
        ],
        "matchers": [
          {
            "field": "to",
            "type": "literal",
            "value": "[email protected]"
          }
        ]
      },
      {
        "actions": [
          {
            "type": "worker",
            "value": [
              "my-worker"
            ]
          }
        ],
        "matchers": [
          {
            "field": "to",
            "type": "literal",
            "value": "[email protected]"
          }
        ]
      },
      {
        "actions": [
          {
            "type": "worker",
            "value": [
              "my-worker"
            ]
          }
        ],
        "matchers": [
          {
            "field": "to",
            "type": "literal",
            "value": "[email protected]"
          }
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get sending limits — cloudflare.email-sending-get-sending-limits

Returns the current daily sending quota for the account and, when a quota is resolved, the account's current usage against it. Quota is null when not yet available; usage is null when there is no resolved quota or usage is temporarily unavailable.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account reputation — cloudflare.email-sending-get-reputation

Returns the authoritative Email Sending reputation state and active evaluation policy. Accounts without an evaluation are Healthy with null evaluation timestamps.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Send an email — cloudflare.email-sending-account-send-builder

Send an email for the specified account using the structured builder. Provide the sender, recipients, subject, and at least one of text or html; attachments are optional.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Identifier of the account.
body — Required $ref: "#/definitions/email-sending_EmailBuilder"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "attachments": [
      {
        "content": "JVBERi0xLjQK...",
        "disposition": "attachment",
        "filename": "report.pdf",
        "type": "application/pdf"
      }
    ],
    "from": "[email protected]",
    "html": "<h1>Hello</h1><p>Please find your report attached.</p>",
    "subject": "Monthly Report",
    "text": "Hello\n\nPlease find your report attached.",
    "to": [
      "[email protected]"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Send a raw MIME email — cloudflare.email-sending-account-send-raw-message

Send a raw RFC 5322 (MIME) email for the specified account. Provide the full MIME message plus the SMTP envelope (from and recipients).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Identifier of the account.
body — Required $ref: "#/definitions/email-sending_SendRawRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "from": "[email protected]",
    "mime_message": "From: [email protected]\r\nTo: [email protected]\r\nSubject: Hello\r\nContent-Type: text/plain\r\n\r\nHello, World!",
    "recipients": [
      "[email protected]"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account Email Sending suppressions — cloudflare.get_publiclistsendingsuppressions

Lists every active Email Sending suppression owned by the account: sending-domain suppressions first, then account-wide suppressions (including legacy rows with internal zone memberships). Each group is newest first.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
query object Optional additionalProperties: false
query.per_page integer Optional Maximum number of suppressions to return per page. default: 100; minimum: 1; maximum: 1000
query.cursor string Optional Opaque pagination cursor returned as result_info.next_cursor. It carries the filters that produced it. maxLength: 2048
query.email string Optional Exact email-address filter. format: "email"
query.search string Optional A complete address is an exact match; a value ending in @ matches that username across every domain. Prefix searches may return short intermediate pages while the bounded account scan advances. minLength: 1; maxLength: 320
query.reason string Optional Filter to suppressions with this reason. enum: ["manual","complaint","hard_bounce","soft_bounce","policy"]
query.scope_type string Optional Filter by scope: account returns only account-wide suppressions, sending_domain only sending-domain suppressions. Omit to list both, sending-domain suppressions first. enum: ["account","sending_domain"]
query.scope_value string Optional Exact sending-domain filter. Requires scope_type=sending_domain. maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create account Email Sending suppression — cloudflare.post_publiccreatesendingsuppression

Creates a suppression for every sending domain of the account (default) or for one sending domain (scope.type = sending_domain). Creating an existing active suppression returns its identifier. If a mutable legacy zone-linked account row already exists, it is promoted without changing its identifier.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Optional
body.email string Required The email address to suppress. format: "email"
body.expires_at string | null Optional Expiration timestamp for the suppression. Omit or set to null for a permanent suppression that never expires. format: "date-time"
body.note string Optional Advisory note for this suppression. Not enforced or validated beyond length. maxLength: 1000
body.scope — Optional Where the suppression applies. Omit for { "type": "account" }, which blocks the recipient for every sending domain of the account.
body.scope object Optional oneOf[1]
body.scope.type string Required Blocks the recipient for every sending domain of the account. oneOf[1]; enum: ["account"]
body.scope object Optional oneOf[2]
body.scope.type string Required Blocks the recipient only for mail whose envelope MAIL FROM uses value. oneOf[2]; enum: ["sending_domain"]
body.scope.value string Required The sending domain to suppress for: the domain part of the envelope MAIL FROM. It is lowercased and trailing dots are removed. Internationalized domains must use the ASCII (punycode) form. Ownership is not checked; a domain the account does not send from never matches. oneOf[2]; maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk import account Email Sending suppressions — cloudflare.post_publicbulkcreatesendingsuppressions

Imports up to 1,000 Email Sending suppressions in one request. Each item applies to every sending domain of the account (default) or to one sending domain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
body object Optional
body.items array Required Suppressions to import. Items with the same email address and scope are deduplicated before processing. maxItems: 1000
body.items[] object Optional
body.items[].email string Required The email address to suppress.
body.items[].expires_at string | null Optional Expiration timestamp for the suppression. Omit or set to null for a permanent suppression that never expires. format: "date-time"
body.items[].note string Optional Advisory note for this suppression. Not enforced or validated beyond length. maxLength: 1000
body.items[].scope — Optional Where the suppression applies. Omit for { "type": "account" }, which blocks the recipient for every sending domain of the account.
body.items[].scope object Optional oneOf[1]
body.items[].scope.type string Required Blocks the recipient for every sending domain of the account. oneOf[1]; enum: ["account"]
body.items[].scope object Optional oneOf[2]
body.items[].scope.type string Required Blocks the recipient only for mail whose envelope MAIL FROM uses value. oneOf[2]; enum: ["sending_domain"]
body.items[].scope.value string Required The sending domain to suppress for: the domain part of the envelope MAIL FROM. It is lowercased and trailing dots are removed. Internationalized domains must use the ASCII (punycode) form. Ownership is not checked; a domain the account does not send from never matches. oneOf[2]; maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "12345678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete account Email Sending suppression — cloudflare.delete_publicdeletesendingsuppression

Deletes the suppression, its note, and every legacy internal zone membership, allowing future delivery attempts to the address.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.suppression_id string Required The suppression's identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "12345678",
    "suppression_id": "396a5436-d4b0-42a6-b3fc-48e8fa522321"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account Email Sending suppression — cloudflare.get_publicgetsendingsuppression

Gets an Email Sending suppression owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.suppression_id string Required The suppression's identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "12345678",
    "suppression_id": "396a5436-d4b0-42a6-b3fc-48e8fa522321"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update account Email Sending suppression — cloudflare.patch_publicupdatesendingsuppression

Updates expiry or advisory note fields without changing legacy internal zone memberships. Scope cannot be changed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID.
path.suppression_id string Required The suppression's identifier. format: "uuid"
body object Optional
body.expires_at string | null Optional New expiry. Send null to make the suppression permanent; omit to leave it unchanged. format: "date-time"
body.note string Optional Replacement advisory note. Send an empty string to clear it; omit to leave it unchanged. maxLength: 1000
body.scope object Optional Not editable. Scope is fixed when the suppression is created; any value returns 400 with code scope_immutable. Delete and recreate the suppression to change it.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "12345678",
    "suppression_id": "396a5436-d4b0-42a6-b3fc-48e8fa522321"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account Entitlements — cloudflare.entitlements-get-account-entitlements

Returns the list of entitlements (features and their allocations) for a given account. Each entitlement describes a product feature the account is permitted to use and the allocation value (boolean, count, range, enum, or string) that governs its behaviour.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Identifier of the account. $ref: "#/definitions/entitlements_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Event Notification Rules — cloudflare.r2-get-event-notification-configs

Lists event notification rules for an R2 bucket, grouped by the Cloudflare Queue that receives matching object events.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Event Subscriptions — cloudflare.subscriptions-list

Returns a paginated list of Queue event subscriptions with optional sorting and filtering.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mq_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number for pagination default: 1; minimum: 1
query.per_page integer Optional Number of items per page default: 20; minimum: 1; maximum: 100
query.order string Optional Field to sort by enum: ["created_at","name","enabled","source"]; default: "name"
query.direction string Optional Sort direction enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Event Subscription — cloudflare.subscriptions-create

Creates an event subscription for a Queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Required
body.destination — Optional $ref: "#/definitions/mq_event-destination"
body.enabled boolean Optional Whether the subscription is active
body.events array Optional List of event types this subscription handles minItems: 1
body.events[] string Optional
body.name string Optional Name of the subscription
body.source — Optional $ref: "#/definitions/mq_event-source"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Event Subscription — cloudflare.subscriptions-delete

Deletes an existing Queue event subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mq_identifier"
path.subscription_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "subscription_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Event Subscription — cloudflare.subscriptions-get

Returns an existing Queue event subscription.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mq_identifier"
path.subscription_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "subscription_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Event Subscription — cloudflare.subscriptions-patch

Updates an existing Queue event subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mq_identifier"
path.subscription_id — Required $ref: "#/definitions/mq_identifier"
body object Required
body.destination — Optional $ref: "#/definitions/mq_event-destination"
body.enabled boolean Optional Whether the subscription is active
body.events array Optional List of event types this subscription handles minItems: 1
body.events[] string Optional
body.name string Optional Name of the subscription

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "subscription_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Field Extractor — cloudflare.deletefieldextractor

Deletes all custom extraction rules for an extractor type.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
path.extractor string Required Extractor type. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "123456",
    "extractor": "llm_prompts"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Field Extractor — cloudflare.getfieldextractor

Retrieves the custom extraction rules configured for a given extractor type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
path.extractor string Required Extractor type. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "123456",
    "extractor": "llm_prompts"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Field Extractor — cloudflare.updatefieldextractor

Replaces all custom extraction rules for an extractor type. Omitted rules are deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID. minLength: 1
path.extractor string Required Extractor type. minLength: 1
body object Optional
body.rules array Required minItems: 1; maxItems: 10
body.rules[] object Optional
body.rules[].description string Optional maxLength: 4096
body.rules[].fields array Required minItems: 1
body.rules[].fields[] object Optional
body.rules[].fields[].expression string Required minLength: 1; maxLength: 4096
body.rules[].fields[].name string Required minLength: 1
body.rules[].ref string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "123456",
    "extractor": "llm_prompts"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IP Access rules — cloudflare.ip-access-rules-for-an-account-list-ip-access-rules

Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/firewall_account_identifier"
query object Optional additionalProperties: false
query.mode — Optional $ref: "#/definitions/firewall_schemas-mode"
query.configuration.target string Optional Defines the target to search in existing rules. enum: ["ip","ip_range","asn","country"]
query.configuration.value string Optional Defines the target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided configuration.target. Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
query.notes string Optional Defines the string to search for in the notes of existing IP Access rules. Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
query.match string Optional Defines the search requirements. When set to all, all the search requirements must match. When set to any, only one of the search requirements has to match. enum: ["any","all"]; default: "all"
query.page number Optional Defines the requested page within paginated list of results.
query.per_page number Optional Defines the maximum number of results requested.
query.order string Optional Defines the field used to sort returned rules. enum: ["configuration.target","configuration.value","mode"]
query.direction string Optional Defines the direction used to sort returned rules. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an IP Access rule — cloudflare.ip-access-rules-for-an-account-delete-an-ip-access-rule

Deletes an existing IP Access rule defined at the account level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/firewall_rule_identifier"
path.account_id — Required $ref: "#/definitions/firewall_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an IP Access rule — cloudflare.ip-access-rules-for-an-account-get-an-ip-access-rule

Fetches the details of an IP Access rule defined at the account level.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/firewall_rule_identifier"
path.account_id — Required $ref: "#/definitions/firewall_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete the payload logging key — cloudflare.payload-logging-keys-for-an-account-delete-the-payload-logging-key

Deletes the payload logging public key of the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/firewall_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the payload logging key — cloudflare.payload-logging-keys-for-an-account-get-the-payload-logging-key

Fetches the public key that payload logging uses to encrypt matched payloads for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/firewall_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the payload logging key — cloudflare.payload-logging-keys-for-an-account-set-the-payload-logging-key

Creates or replaces the public key that payload logging uses to encrypt matched payloads for the account. It applies to every zone in the account that has no zone key. Requires a plan that includes payload logging (Enterprise); otherwise it returns 403.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/firewall_account_identifier"
body — Required $ref: "#/definitions/firewall_payload_logging_key"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "public_key": "Ycig/Zr/pZmklmFUN99nr+taURlYItL91g+NcHGYpB8="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List apps — cloudflare.flagship_list_apps

Lists all Flagship apps in the account. Returns identity and audit fields only; flag definitions are not included.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create app — cloudflare.flagship_create_app

Creates an app. The returned id is used in all subsequent flag, changelog, and evaluation requests.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
body object Required additionalProperties: false
body.name string Required Name of the Flagship app (1–64 letters, numbers, hyphens, or underscores). minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete app — cloudflare.flagship_delete_app

Deletes an app and all its flags and changelog history. Returns 409 if any Worker still references this app via a Flagship binding.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get app — cloudflare.flagship_get_app

Returns an app's name and audit fields. Flag definitions are not included.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update app — cloudflare.flagship_update_app

Updates an app. Only name is mutable.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
body object Required additionalProperties: false
body.name string Optional Name of the Flagship app (1–64 letters, numbers, hyphens, or underscores). minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get flag definitions — cloudflare.flagship_get_definitions

Returns an app's evaluation-only flag definitions for SDKs that evaluate locally. Send the returned ETag in If-None-Match to avoid downloading unchanged definitions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
headers object Optional additionalProperties: false
headers.If-None-Match string Optional Previously returned ETag, or *.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Evaluate flag from query context — cloudflare.flagship_evaluate_flag

Evaluates a flag against the provided context. Pass context attributes as query parameters; values are coerced to numbers or booleans where unambiguous. For low-latency in-Worker evaluation, prefer the Flagship binding over this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
query object Required additionalProperties: false
query.flagKey string Required The flag key to evaluate.
query.targetingKey string Optional Context targeting key (per OpenFeature spec); used for percentage rollout bucketing.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  },
  "query": {
    "flagKey": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Evaluate flag with JSON context — cloudflare.flagship_evaluate_flag_post

Evaluates a flag against the provided context, passed as a JSON request body (OFREP-shaped) rather than query parameters. Returns the same response shape as the GET variant.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
body object Required additionalProperties: false
body.context object Optional Evaluation attributes keyed by name. Values may be any JSON value; the context supports up to 100 entries, nesting depth of 10, 10,000 values, and 32 KB. default: {}; additionalProperties: {"$ref":"#/definitions/flagship_JsonValue"}
body.flagKey string Required Key of the flag to evaluate within the app. minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  },
  "body": {
    "flagKey": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List flags — cloudflare.flagship_list_flags

Lists an app's flags ordered by key. Pass cursor from result_info to page forward; a null cursor indicates the last page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
query object Optional additionalProperties: false
query.limit integer Optional Max items to return (1–200). minimum: 1; maximum: 200
query.cursor string Optional Pagination cursor from a previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create flag — cloudflare.flagship_create_flag

Creates a flag. Returns 409 if the key already exists. type is always inferred from variation values; legacy request-side values are ignored. Optional metadata can be attached at creation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
body object Required additionalProperties: false
body.default_variation string Required Variation the API serves when the flag is off, or when it's on but no rule matches the context. Must be a key in variations. minLength: 1
body.description string | null Optional Optional operator-facing description. It does not affect flag evaluation. maxLength: 512
body.enabled boolean Required When false, the flag bypasses all rules and always serves default_variation.
body.key string Required Unique identifier for the flag within an app. Used in all evaluation and SDK calls. minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_-]+$"
body.metadata object | null Optional Key-value metadata associated with the flag. null or an empty object clears existing metadata; omission semantics depend on the endpoint (PUT clears it, PATCH preserves it). maxProperties: 32; additionalProperties: {"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"}]}
body.rules array Required Targeting rules evaluated in ascending priority; the first matching rule wins. An empty array means the flag always serves default_variation.
body.rules[] — Optional $ref: "#/definitions/flagship_Rule"
body.type string Optional Deprecated compatibility field. Omit it; the API ignores this value and infers the type from the flag's variations. enum: ["boolean","string","number","json"]
body.variations object Required Map of variation name to value. All values share the same type (boolean, string, number, or JSON object/array), and each serialized value stays within 10KB. additionalProperties: {"$ref":"#/definitions/flagship_JsonValue"}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example"
  },
  "body": {
    "key": "example",
    "default_variation": "example",
    "variations": {},
    "rules": [],
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete flag — cloudflare.flagship_delete_flag

Deletes a flag permanently. After deletion propagates, direct evaluations return not found; typed binding accessors may return the caller-supplied default. Cannot be undone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
path.flag_key string Required Case-sensitive key identifying the flag within the app.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example",
    "flag_key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get flag — cloudflare.flagship_get_flag

Returns the full flag definition including rules, variations, metadata, and audit fields.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
path.flag_key string Required Case-sensitive key identifying the flag within the app.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example",
    "flag_key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Partially update flag — cloudflare.flagship_patch_flag

Applies a partial update to lightweight flag fields: enabled, description, metadata, and default_variation. Only fields present in the request body are modified; omitted fields are preserved. metadata: null or an empty object clears metadata. default_variation must exist in the current variations. Structural changes to variations and rules use PUT. A changelog entry is appended when the flag content actually changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
path.flag_key string Required Case-sensitive key identifying the flag within the app.
body object Required additionalProperties: false
body.default_variation string Optional Variation the API serves when the flag is off, or when it's on but no rule matches the context. Must be a key in variations. minLength: 1
body.description string | null Optional Optional operator-facing description. It does not affect flag evaluation. maxLength: 512
body.enabled boolean Optional When false, the flag bypasses all rules and always serves default_variation.
body.metadata object | null Optional Key-value metadata associated with the flag. null or an empty object clears existing metadata; omission semantics depend on the endpoint (PUT clears it, PATCH preserves it). maxProperties: 32; additionalProperties: {"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"}]}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example",
    "flag_key": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update flag — cloudflare.flagship_update_flag

Replaces the entire flag definition. Omitted fields are cleared, not preserved — read before writing. The path key identifies the flag and cannot be renamed by changing the body key. A changelog entry is appended when the flag content actually changes; identical updates are no-ops.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
path.flag_key string Required Case-sensitive key identifying the flag within the app.
body object Required additionalProperties: false
body.default_variation string Required Variation the API serves when the flag is off, or when it's on but no rule matches the context. Must be a key in variations. minLength: 1
body.description string | null Optional Optional operator-facing description. It does not affect flag evaluation. maxLength: 512
body.enabled boolean Required When false, the flag bypasses all rules and always serves default_variation.
body.key string Required Unique identifier for the flag within an app. Used in all evaluation and SDK calls. minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_-]+$"
body.metadata object | null Optional Key-value metadata associated with the flag. null or an empty object clears existing metadata; omission semantics depend on the endpoint (PUT clears it, PATCH preserves it). maxProperties: 32; additionalProperties: {"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"}]}
body.rules array Required Targeting rules evaluated in ascending priority; the first matching rule wins. An empty array means the flag always serves default_variation.
body.rules[] — Optional $ref: "#/definitions/flagship_Rule"
body.type string Optional Deprecated compatibility field. Omit it; the API ignores this value and infers the type from the flag's variations. enum: ["boolean","string","number","json"]
body.variations object Required Map of variation name to value. All values share the same type (boolean, string, number, or JSON object/array), and each serialized value stays within 10KB. additionalProperties: {"$ref":"#/definitions/flagship_JsonValue"}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example",
    "flag_key": "example"
  },
  "body": {
    "key": "example",
    "default_variation": "example",
    "variations": {},
    "rules": [],
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List flag changelog entries — cloudflare.flagship_get_flag_changelog

Returns the audit history for a flag, newest first. Each entry includes the event type and full flag state after the change; update entries include a field-level diff. Capped at 200 entries per flag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account ID that owns the Flagship app.
path.app_id string Required Flagship app ID returned when the app was created.
path.flag_key string Required Case-sensitive key identifying the flag within the app.
query object Optional additionalProperties: false
query.limit integer Optional Max items to return (1–200). minimum: 1; maximum: 200
query.cursor string Optional Pagination cursor from a previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "app_id": "example",
    "flag_key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust account information — cloudflare.zero-trust-accounts-get-zero-trust-account-information

Retrieve information about the current Zero Trust account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Zero Trust account — cloudflare.zero-trust-accounts-create-zero-trust-account

Create a Zero Trust account for an existing Cloudflare account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List application and application type mappings — cloudflare.zero-trust-gateway-application-and-application-type-mappin-ae71b8b2fb

List all application and application type mappings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List applications review statuses — cloudflare.zero-trust-applications-review-status-list

Retrieve the statuses of your applications.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update applications review statuses — cloudflare.zero-trust-applications-review-status-update

Update the statuses of your applications.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-3"
body object Required
body.approved_apps — Required $ref: "#/definitions/zero-trust-gateway_approved_apps"
body.in_review_apps — Required $ref: "#/definitions/zero-trust-gateway_in_review_apps"
body.unapproved_apps — Required $ref: "#/definitions/zero-trust-gateway_unapproved_apps"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "approved_apps": [],
    "unapproved_apps": [],
    "in_review_apps": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust SSH settings — cloudflare.zero-trust-get-audit-ssh-settings

Retrieve SSH with Access for Infrastructure settings for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zero Trust SSH settings — cloudflare.zero-trust-update-audit-ssh-settings

Update SSH with Access for Infrastructure settings for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.public_key — Required $ref: "#/definitions/zero-trust-gateway_public_key"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "public_key": "1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate Zero Trust SSH account seed — cloudflare.zero-trust-rotate-ssh-account-seed

Rotate the SSH account seed that generates the host key identity when connecting through the Cloudflare SSH Proxy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List categories — cloudflare.zero-trust-gateway-categories-list-categories

List all categories.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zero Trust certificates — cloudflare.zero-trust-certificates-list-zero-trust-certificates

List all Zero Trust certificates for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Zero Trust certificate — cloudflare.zero-trust-certificates-create-zero-trust-certificate

Create a new Zero Trust certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body — Optional $ref: "#/definitions/zero-trust-gateway_generate-cert-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Zero Trust certificate — cloudflare.zero-trust-certificates-delete-zero-trust-certificate

Delete a gateway-managed Zero Trust certificate. You must deactivate the certificate from the edge (inactive) before deleting it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/zero-trust-gateway_uuid"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust certificate details — cloudflare.zero-trust-certificates-zero-trust-certificate-details

Get a single Zero Trust certificate.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/zero-trust-gateway_uuid"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Activate a Zero Trust certificate — cloudflare.zero-trust-certificates-activate-zero-trust-certificate

Bind a single Zero Trust certificate to the edge.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/zero-trust-gateway_uuid"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deactivate a Zero Trust certificate — cloudflare.zero-trust-certificates-deactivate-zero-trust-certificate

Unbind a single Zero Trust certificate from the edge.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/zero-trust-gateway_uuid"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust account configuration — cloudflare.zero-trust-accounts-get-zero-trust-account-configuration

Retrieve the current Zero Trust account configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Zero Trust account configuration — cloudflare.zero-trust-accounts-patch-zero-trust-account-configuration

Update (PATCH) a single subcollection of settings such as antivirus, tls_decrypt, activity_log, block_page, browser_isolation, fips, body_scanning, certificate, or max_ttl_secs without updating the entire configuration object. This endpoint returns an error if any settings collection lacks proper configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"
body — Required $ref: "#/definitions/zero-trust-gateway_gateway-account-settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zero Trust account configuration — cloudflare.zero-trust-accounts-update-zero-trust-account-configuration.

Update the current Zero Trust account configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"
body — Required $ref: "#/definitions/zero-trust-gateway_gateway-account-settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zero Trust Gateway DNS destination IPv4 address pairs — cloudflare.zero-trust-dns-destination-ips-list-dns-destination-ips

List Zero Trust Gateway IPv4 address pairs for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get gateway egress CIDRs pairs assigned to this account — cloudflare.zero-trust-accounts-get-egress-cidr-pairs

Retrieve the list of egress CIDRs allocated to this Zero Trust account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zero Trust lists — cloudflare.zero-trust-lists-list-zero-trust-lists

Fetch all Zero Trust lists for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
query object Optional additionalProperties: false
query.type — Optional $ref: "#/definitions/zero-trust-gateway_type-2"
query.filter array Optional Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned). Supported fields and their matching behaviour: * name — case-insensitive substring match on the list name. * id — substring match on the list ID (UUID), with or without dashes. * type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values. * item_count — exact integer match on the number of items in the list. Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or item_count; name/id accept any value, type is restricted to the valid list type values, and item_count must be a non-negative integer.
query.filter[] string Optional
query.filter[] string Optional anyOf[1]; pattern: "^name:.*$"
query.filter[] string Optional anyOf[2]; pattern: "^id:.*$"
query.filter[] string Optional anyOf[3]; pattern: "^type:(IP|URL|DOMAIN|CATEGORY|EMAIL|SERIAL|LOCATION|DEVICE|AAGUID)$"
query.filter[] string Optional anyOf[4]; pattern: "^item_count:[0-9]+$"
query.search string Optional Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
query.order_by string Optional Field to sort the returned lists by. When omitted, results are ordered by created_at in ascending order (i.e. creation order) for backwards compatibility. Supported values: * name — sort alphabetically by list name. * created_at — sort by creation time; defaults to descending unless direction is set. * updated_at — sort by last-modified time; defaults to descending unless direction is set. * item_count — sort by number of items in the list. enum: ["name","created_at","updated_at","item_count"]
query.direction string Optional Sort direction. Applies to the field named in order_by; when order_by is omitted it applies to the default created_at ordering. When direction is omitted the default is field-specific: explicitly choosing created_at or updated_at defaults to descending (newest first); name and item_count default to ascending; and the default created_at ordering used when order_by is omitted is ascending (for backwards compatibility). * asc — ascending. * desc — descending. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Zero Trust list — cloudflare.zero-trust-lists-create-zero-trust-list

Creates a new Zero Trust list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.description — Optional $ref: "#/definitions/zero-trust-gateway_description"
body.items — Optional $ref: "#/definitions/zero-trust-gateway_items-input"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name"
body.type — Required $ref: "#/definitions/zero-trust-gateway_type-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Admin Serial Numbers",
    "type": "SERIAL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Zero Trust list — cloudflare.zero-trust-lists-delete-zero-trust-list

Deletes a Zero Trust list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-2"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust list details — cloudflare.zero-trust-lists-zero-trust-list-details

Fetch a single Zero Trust list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-2"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Zero Trust list. — cloudflare.zero-trust-lists-patch-zero-trust-list

Appends or removes an item from a configured Zero Trust list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-2"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.append — Optional $ref: "#/definitions/zero-trust-gateway_items-input"
body.remove array Optional Lists of item values you want to remove.
body.remove[] — Optional $ref: "#/definitions/zero-trust-gateway_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zero Trust list — cloudflare.zero-trust-lists-update-zero-trust-list

Updates a configured Zero Trust list. Skips updating list items if not included in the payload. A non empty list items will overwrite the existing list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-2"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.description — Optional $ref: "#/definitions/zero-trust-gateway_description"
body.items — Optional $ref: "#/definitions/zero-trust-gateway_items-input"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Admin Serial Numbers"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust list items — cloudflare.zero-trust-lists-zero-trust-list-items

Fetch all items in a single Zero Trust list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-2"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of items per page. default: 50; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zero Trust Gateway locations — cloudflare.zero-trust-gateway-locations-list-zero-trust-gateway-locations

List Zero Trust Gateway locations for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
query object Optional additionalProperties: false
query.filter array Optional Filter the returned locations by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a location must satisfy every filter to be returned). Supported fields and their matching behaviour: * name — case-insensitive substring match on the location name. * id — substring match on the location ID (UUID), with or without dashes. * is_default — whether it is the default for the account. Each entry must match one of the per-field patterns below: * the field must be one of name, id, or is_default; * name/id accept any value; * is_default only accepts true or false; any other value returns 400
query.filter[] string Optional
query.filter[] string Optional anyOf[1]; pattern: "^name:.*$"
query.filter[] string Optional anyOf[2]; pattern: "^id:.*$"
query.filter[] string Optional anyOf[3]; pattern: "^is_default:(true|false)$"
query.search string Optional Case-insensitive substring match on the location name. When combined with filter, both must match (logical AND).
query.order_by string Optional Field to sort the returned locations by. When omitted, the order of results is unspecified. Supported values: * name — sort alphabetically by location name. * created_at — sort by creation time; defaults to descending unless direction is set. * updated_at — sort by last-modified time; defaults to descending unless direction is set. enum: ["name","created_at","updated_at"]
query.direction string Optional Sort direction. Only takes effect when order_by is also provided; it is ignored otherwise. When direction is omitted the effective direction is field-specific: created_at and updated_at default to descending (newest first); name defaults to ascending. * asc — ascending. * desc — descending. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Zero Trust Gateway location — cloudflare.zero-trust-gateway-locations-create-zero-trust-gateway-location

Create a new Zero Trust Gateway location.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.client_default — Optional $ref: "#/definitions/zero-trust-gateway_client-default"
body.dns64_enabled — Optional $ref: "#/definitions/zero-trust-gateway_dns64-enabled"
body.dns_destination_ips_id — Optional $ref: "#/definitions/zero-trust-gateway_dns-destination-ips-id-write"
body.ecs_support — Optional $ref: "#/definitions/zero-trust-gateway_ecs-support"
body.endpoints — Optional $ref: "#/definitions/zero-trust-gateway_endpoints"
body.max_ttl — Optional $ref: "#/definitions/zero-trust-gateway_max-ttl"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name-2"
body.networks — Optional $ref: "#/definitions/zero-trust-gateway_ipv4_networks"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Austin Office Location"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Zero Trust Gateway location — cloudflare.zero-trust-gateway-locations-delete-zero-trust-gateway-location

Delete a configured Zero Trust Gateway location.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.location_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "location_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust Gateway location details — cloudflare.zero-trust-gateway-locations-zero-trust-gateway-location-details

Get a single Zero Trust Gateway location.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.location_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "location_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Zero Trust Gateway location — cloudflare.zero-trust-gateway-locations-update-zero-trust-gateway-location

Update a configured Zero Trust Gateway location.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.location_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.client_default — Optional $ref: "#/definitions/zero-trust-gateway_client-default"
body.dns64_enabled — Optional $ref: "#/definitions/zero-trust-gateway_dns64-enabled"
body.dns_destination_ips_id — Optional $ref: "#/definitions/zero-trust-gateway_dns-destination-ips-id-write"
body.ecs_support — Optional $ref: "#/definitions/zero-trust-gateway_ecs-support"
body.endpoints — Optional $ref: "#/definitions/zero-trust-gateway_endpoints"
body.max_ttl — Optional $ref: "#/definitions/zero-trust-gateway_max-ttl"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name-2"
body.networks — Optional $ref: "#/definitions/zero-trust-gateway_ipv4_networks"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "location_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Austin Office Location"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get logging settings for the Zero Trust account — cloudflare.zero-trust-accounts-get-logging-settings-for-the-zero-trust-account

Retrieve the current logging settings for the Zero Trust account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zero Trust account logging settings — cloudflare.zero-trust-accounts-update-logging-settings-for-the-zero-t-bc8951dcc5

Update logging settings for the current Zero Trust account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier"
body — Required $ref: "#/definitions/zero-trust-gateway_gateway-account-logging-settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zero Trust Gateway operations — cloudflare.zero-trust-gateway-operations-list-zero-trust-gateway-operations

List all Zero Trust Gateway operations for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Zero Trust Gateway operation details — cloudflare.zero-trust-gateway-operations-zero-trust-gateway-operation-details

Fetch a single Zero Trust Gateway operation by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.operation_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-2"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List PAC files — cloudflare.zero-trust-gateway-pacfiles-list

List all Zero Trust Gateway PAC files for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of items per page. default: 50; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a PAC file — cloudflare.zero-trust-gateway-pacfiles-create-pacfile

Create a new Zero Trust Gateway PAC file.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.contents — Required $ref: "#/definitions/zero-trust-gateway_contents"
body.description — Optional $ref: "#/definitions/zero-trust-gateway_description-4"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name-7"
body.slug string Optional URL-friendly version of the PAC file name. If not provided, it will be auto-generated

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Devops team",
    "contents": "function FindProxyForURL(url, host) { return \"DIRECT\"; }"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a PAC file — cloudflare.zero-trust-gateway-pacfiles-delete

Delete a configured Zero Trust Gateway PAC file.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pacfile_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pacfile_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a PAC file — cloudflare.zero-trust-gateway-pacfiles-details

Get a single Zero Trust Gateway PAC file.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pacfile_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pacfile_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Zero Trust Gateway PAC file — cloudflare.zero-trust-gateway-pacfiles-update

Update a configured Zero Trust Gateway PAC file.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pacfile_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.contents — Required $ref: "#/definitions/zero-trust-gateway_contents"
body.description — Required $ref: "#/definitions/zero-trust-gateway_description-4"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name-7"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pacfile_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Devops team",
    "description": "PAC file for Devops team",
    "contents": "function FindProxyForURL(url, host) { return \"DIRECT\"; }"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List proxy endpoints — cloudflare.zero-trust-gateway-proxy-endpoints-list-proxy-endpoints

List all Zero Trust Gateway proxy endpoints for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
query object Optional additionalProperties: false
query.filter array Optional Filter the returned proxy endpoints by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (an endpoint must satisfy every filter to be returned). Supported fields and their matching behaviour: * name — case-insensitive substring match on the endpoint name. * id — substring match on the endpoint ID (UUID), with or without dashes. * kind — exact match on the endpoint kind. The value must be ip or identity; any other value returns 400. Each entry must match one of the per-field patterns below: the field must be one of name, id, or kind; name/id accept any value, while kind only accepts ip or identity.
query.filter[] string Optional
query.filter[] string Optional anyOf[1]; pattern: "^name:.*$"
query.filter[] string Optional anyOf[2]; pattern: "^id:.*$"
query.filter[] string Optional anyOf[3]; pattern: "^kind:(ip|identity)$"
query.search string Optional Case-insensitive substring match on the endpoint name. When combined with filter, both must match (logical AND).
query.order_by string Optional Field to sort the returned endpoints by. When omitted, the order of results is unspecified. Supported values: * name — sort alphabetically by endpoint name. * created_at — sort by creation time; defaults to descending unless direction is set. * updated_at — sort by last-modified time; defaults to descending unless direction is set. enum: ["name","created_at","updated_at"]
query.direction string Optional Sort direction. Only takes effect when order_by is also provided; it is ignored otherwise. When direction is omitted the effective direction is field-specific: created_at and updated_at default to descending (newest first); name defaults to ascending. * asc — ascending. * desc — descending. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-create-proxy-endpoint

Create a new Zero Trust Gateway proxy endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.kind string Optional The proxy endpoint kind. enum: ["ip","identity"]; default: "ip"
body — Required oneOf[1]; $ref: "#/definitions/zero-trust-gateway_proxy-endpoint-ip-create"
body — Required oneOf[2]; $ref: "#/definitions/zero-trust-gateway_proxy-endpoint-identity-create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "Devops team",
    "ips": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint

Delete a configured Zero Trust Gateway proxy endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.proxy_endpoint_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "proxy_endpoint_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-proxy-endpoint-details

Get a single Zero Trust Gateway proxy endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.proxy_endpoint_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "proxy_endpoint_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a proxy endpoint — cloudflare.zero-trust-gateway-proxy-endpoints-update-proxy-endpoint

Update a configured Zero Trust Gateway proxy endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.proxy_endpoint_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-3"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.ips — Optional $ref: "#/definitions/zero-trust-gateway_ips"
body.name — Optional $ref: "#/definitions/zero-trust-gateway_name-6"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "proxy_endpoint_id": "ed35569b41ce4d1facfe683550f54086",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zero Trust Gateway rules — cloudflare.zero-trust-gateway-rules-list-zero-trust-gateway-rules

List Zero Trust Gateway rules for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
query object Optional additionalProperties: false
query.filter array Optional Filter the returned rules by one or more field:value pairs. Repeat the parameter to combine filters with logical AND. Supported fields are name, id, action, enabled, source_account, is_shared, filters, and expression (max 1024 bytes). The source_account value is matched as a normalized UUID substring. The filters value must be one of the rule filter names and matches a member of the rule's filters array. The expression filter performs a case-insensitive literal substring match across traffic, identity, and device posture expressions.
query.filter[] string Optional
query.filter[] string Optional anyOf[1]; pattern: "^name:.*$"
query.filter[] string Optional anyOf[2]; pattern: "^id:.*$"
query.filter[] string Optional anyOf[3]; pattern: "^action:(on|off|allow|block|scan|noscan|safesearch|ytrestricted|isolate|noisolate|override|l4_override|egress|resolve|quarantine|redirect|forward)$"
query.filter[] string Optional anyOf[4]; pattern: "^enabled:(true|false)$"
query.filter[] string Optional anyOf[5]; pattern: "^source_account:.*$"
query.filter[] string Optional anyOf[6]; pattern: "^is_shared:(true|false)$"
query.filter[] string Optional anyOf[7]; pattern: "^filters:(http|dns|dns_resolver|l4|egress)$"
query.filter[] string Optional anyOf[8]; pattern: "^expression:.*$"
query.search string Optional Case-insensitive substring search across rule name and description.
query.order_by string Optional Field to sort the returned rules by. Supported values are name, created_at, updated_at, and precedence. enum: ["name","created_at","updated_at","precedence"]
query.direction string Optional Sort direction. When order_by is omitted, this controls the direction of the existing precedence ordering. Shared rules remain first in either direction. Accepted values are asc and desc. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch multiple Zero Trust Gateway rules — cloudflare.zero-trust-gateway-rules-patch-multiple-zero-trust-gateway-rules

Update select fields of multiple Zero Trust Gateway rules in a single request. This is commonly used to reorder rules by updating their precedence values. Only the fields provided for each rule are updated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body array Required
body[] object Optional
body[].description — Optional $ref: "#/definitions/zero-trust-gateway_description-2"
body[].enabled — Optional $ref: "#/definitions/zero-trust-gateway_enabled"
body[].id — Required $ref: "#/definitions/zero-trust-gateway_uuid-4"
body[].name — Optional $ref: "#/definitions/zero-trust-gateway_name-3"
body[].precedence — Optional $ref: "#/definitions/zero-trust-gateway_precedence"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-create-zero-trust-gateway-rule

Create a new Zero Trust Gateway rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.action — Required $ref: "#/definitions/zero-trust-gateway_action"
body.description — Optional $ref: "#/definitions/zero-trust-gateway_description-2"
body.device_posture — Optional $ref: "#/definitions/zero-trust-gateway_device_posture"
body.enabled — Optional $ref: "#/definitions/zero-trust-gateway_enabled"
body.expiration — Optional $ref: "#/definitions/zero-trust-gateway_expiration"
body.filters — Optional $ref: "#/definitions/zero-trust-gateway_filters"
body.identity — Optional $ref: "#/definitions/zero-trust-gateway_identity"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name-3"
body.precedence — Optional $ref: "#/definitions/zero-trust-gateway_precedence"
body.rule_settings — Optional $ref: "#/definitions/zero-trust-gateway_rule-settings"
body.schedule — Optional $ref: "#/definitions/zero-trust-gateway_schedule"
body.traffic — Optional $ref: "#/definitions/zero-trust-gateway_traffic"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "block bad websites",
    "action": "allow"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zero Trust Gateway rules inherited from the parent account — cloudflare.zero-trust-gateway-rules-list-zero-trust-gateway-rules-tenant

List Zero Trust Gateway rules for the parent account of an account in the MSP configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-delete-zero-trust-gateway-rule

Delete a Zero Trust Gateway rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-4"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust Gateway rule details. — cloudflare.zero-trust-gateway-rules-zero-trust-gateway-rule-details

Get a single Zero Trust Gateway rule.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-4"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-patch-zero-trust-gateway-rule

Update select fields of an existing Zero Trust Gateway rule. Only the fields provided in the request body are updated. This endpoint supports a limited subset of fields (name, description, precedence, enabled). To update other fields such as action, traffic, identity, device_posture, rule_settings, schedule, or expiration, use the PUT endpoint for a full rule replacement.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-4"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.description — Optional $ref: "#/definitions/zero-trust-gateway_description-2"
body.enabled — Optional $ref: "#/definitions/zero-trust-gateway_enabled"
body.name — Optional $ref: "#/definitions/zero-trust-gateway_name-3"
body.precedence — Optional $ref: "#/definitions/zero-trust-gateway_precedence"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Zero Trust Gateway rule — cloudflare.zero-trust-gateway-rules-update-zero-trust-gateway-rule

Update a configured Zero Trust Gateway rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-4"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"
body object Required
body.action — Required $ref: "#/definitions/zero-trust-gateway_action"
body.description — Optional $ref: "#/definitions/zero-trust-gateway_description-2"
body.device_posture — Optional $ref: "#/definitions/zero-trust-gateway_device_posture"
body.enabled — Optional $ref: "#/definitions/zero-trust-gateway_enabled"
body.expiration — Optional $ref: "#/definitions/zero-trust-gateway_expiration"
body.filters — Optional $ref: "#/definitions/zero-trust-gateway_filters"
body.identity — Optional $ref: "#/definitions/zero-trust-gateway_identity"
body.name — Required $ref: "#/definitions/zero-trust-gateway_name-3"
body.precedence — Optional $ref: "#/definitions/zero-trust-gateway_precedence"
body.rule_settings — Optional $ref: "#/definitions/zero-trust-gateway_rule-settings"
body.schedule — Optional $ref: "#/definitions/zero-trust-gateway_schedule"
body.traffic — Optional $ref: "#/definitions/zero-trust-gateway_traffic"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "block bad websites",
    "action": "allow"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset the expiration of a Zero Trust Gateway Rule — cloudflare.zero-trust-gateway-rules-reset-expiration-zero-trust-gateway-rule

Resets the expiration of a Zero Trust Gateway Rule if its duration elapsed and it has a default duration. The Zero Trust Gateway Rule must have values for both expiration.expires_at and expiration.duration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/zero-trust-gateway_uuid-4"
path.account_id — Required $ref: "#/definitions/zero-trust-gateway_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Hyperdrives — cloudflare.list-hyperdrive

Returns a list of Hyperdrives.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Hyperdrive — cloudflare.create-hyperdrive

Creates and returns a new Hyperdrive configuration. For a PlanetScale integration, the Cloudflare account must already be linked to PlanetScale in the Hyperdrive dashboard.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"
body — Required $ref: "#/definitions/hyperdrive_hyperdrive-config-create"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "example-hyperdrive",
    "origin": {
      "scheme": "postgres",
      "database": "postgres",
      "user": "postgres",
      "password": "example",
      "host": "database.example.com",
      "port": 5432
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Hyperdrive — cloudflare.delete-hyperdrive

Deletes the specified Hyperdrive.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"
path.hyperdrive_id — Required The unique identifier of the Hyperdrive configuration. $ref: "#/definitions/hyperdrive_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hyperdrive_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Hyperdrive — cloudflare.get-hyperdrive

Returns the specified Hyperdrive configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"
path.hyperdrive_id — Required The unique identifier of the Hyperdrive configuration. $ref: "#/definitions/hyperdrive_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hyperdrive_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Hyperdrive — cloudflare.patch-hyperdrive

Updates and returns the specified fields of the Hyperdrive configuration. Custom caching settings are not kept if caching is disabled. For an integration-backed configuration, the integration association is preserved but cannot be changed; omit the integration field.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"
path.hyperdrive_id — Required The unique identifier of the Hyperdrive configuration. $ref: "#/definitions/hyperdrive_identifier"
body — Required $ref: "#/definitions/hyperdrive_hyperdrive-config-patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hyperdrive_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Hyperdrive — cloudflare.update-hyperdrive

Replaces and returns the specified Hyperdrive configuration. The request must include the name and complete origin connection details. Omitted caching settings are reset to their defaults, while omitted mTLS settings and origin connection limits are preserved. The integration association is set only during creation and cannot be changed; omit the integration field even when replacing an integration-backed configuration. Use the update operation to modify only selected fields.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"
path.hyperdrive_id — Required The unique identifier of the Hyperdrive configuration. $ref: "#/definitions/hyperdrive_identifier"
body — Required $ref: "#/definitions/hyperdrive_hyperdrive-config"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hyperdrive_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "example-hyperdrive",
    "origin": {
      "scheme": "postgres",
      "database": "postgres",
      "user": "postgres",
      "password": "example",
      "host": "database.example.com",
      "port": 5432
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restart Hyperdrive — cloudflare.restart-hyperdrive

Restarts the connection pool for the specified Hyperdrive configuration without changing its configuration. Existing connections are drained and a new pool is established at the edge.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"
path.hyperdrive_id — Required The unique identifier of the Hyperdrive configuration. $ref: "#/definitions/hyperdrive_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hyperdrive_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Database Signature — cloudflare.create-hyperdrive-database-signature

Returns a short-lived signed authorization for creating a database that is billed through Cloudflare. The caller passes these values to the integration partner's own CLI, which verifies the signature before creating the database. Requires the account to be entitled to Cloudflare-billed databases for the integration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The Cloudflare account ID. $ref: "#/definitions/hyperdrive_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Account Permission Groups — cloudflare.account-permission-group-list

List all the permissions groups for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.id string Optional ID of the permission group to be fetched. minLength: 32; maxLength: 32
query.name string Optional Name of the permission group to be fetched.
query.label string Optional Label of the permission group to be fetched.
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Permission Group Details — cloudflare.account-permission-group-details

Get information about a specific permission group in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.permission_group_id — Required $ref: "#/definitions/iam_permission_group_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "permission_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Resource Groups — cloudflare.account-resource-group-list

List all the resource groups for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.id — Optional ID of the resource group to be fetched.
query.id — Optional allOf[1]; $ref: "#/definitions/iam_resource_group_identifier"
query.name string Optional Name of the resource group to be fetched.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Resource Group — cloudflare.account-resource-group-create

Create a new Resource Group under the specified account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required $ref: "#/definitions/iam_request_create_resource_group"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "NewResourceGroup",
    "scope": {
      "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
      "objects": []
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Resource Group — cloudflare.account-resource-group-delete

Remove a resource group from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.resource_group_id — Required $ref: "#/definitions/iam_resource_group_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resource Group Details — cloudflare.account-resource-group-details

Get information about a specific resource group in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.resource_group_id — Required $ref: "#/definitions/iam_resource_group_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Resource Group — cloudflare.account-resource-group-update

Modify an existing resource group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.resource_group_id — Required $ref: "#/definitions/iam_resource_group_identifier"
body — Required $ref: "#/definitions/iam_request_update_resource_group"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List User Groups — cloudflare.account-user-group-list

List all the user groups for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.id — Optional ID of the user group to be fetched. $ref: "#/definitions/iam_user_group_identifier"
query.name string Optional Name of the user group to be fetched.
query.fuzzyName string Optional A string used for searching for user groups containing that substring.
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 100; minimum: 1; maximum: 500
query.direction string Optional The sort order of returned user groups by name (ascending or descending). enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create User Group — cloudflare.account-user-group-create

Create a new user group under the specified account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required $ref: "#/definitions/iam_create_user_group_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "My New User Group"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove User Group — cloudflare.account-user-group-delete

Remove a user group from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

User Group Details — cloudflare.account-user-group-details

Get information about a specific user group in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update User Group — cloudflare.account-user-group-update

Modify an existing user group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"
body — Required $ref: "#/definitions/iam_update_user_group_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List User Group Members — cloudflare.account-user-group-member-list

List all the members attached to a user group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 100; minimum: 1; maximum: 500
query.fuzzyEmail string Optional A string used for filtering members by partial email match.
query.direction string Optional The sort order of returned user group members by email. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add User Group Members — cloudflare.account-user-group-member-create

Add members to a User Group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"
body array Required
body[] object Optional
body[].id — Required $ref: "#/definitions/iam_user_group_member_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update User Group Members — cloudflare.account-user-group-members-update

Replace the set of members attached to a User Group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"
body array Required Set/Replace members to a user group.
body[] object Optional
body[].id — Required $ref: "#/definitions/iam_user_group_member_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove User Group Member — cloudflare.account-user-group-member-delete

Remove a member from User Group

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"
path.member_id — Required $ref: "#/definitions/iam_user_group_member_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "member_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get User Group Member — cloudflare.account-user-group-member-get

Get details of a specific member in a user group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_group_id — Required $ref: "#/definitions/iam_user_group_identifier"
path.member_id — Required $ref: "#/definitions/iam_user_group_member_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_group_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "member_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Signing Keys — cloudflare.cloudflare-images-keys-list-signing-keys

List your CF Images signing keys.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Signing Key — cloudflare.cloudflare-images-keys-delete-signing-key

Delete a CF Images signing key with specified name. Returns all keys available. When the last key is removed, a new default signing key will be generated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.signing_key_name — Required $ref: "#/definitions/images_signing_key_identifier"
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "signing_key_name": "someKey",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Signing Key — cloudflare.cloudflare-images-keys-add-signing-key

Create a new CF Images signing key with specified name. Returns all keys available.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.signing_key_name — Required $ref: "#/definitions/images_signing_key_identifier"
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "signing_key_name": "someKey",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Images usage statistics — cloudflare.cloudflare-images-images-usage-statistics

Fetch image statistics details for Cloudflare Images. The returned statistics detail storage usage, including the current image count vs this account's allowance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List variants — cloudflare.cloudflare-images-variants-list-variants

List existing CF Images variants.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a variant — cloudflare.cloudflare-images-variants-create-a-variant

Create a CF Images variant that allows you to resize images for different use cases.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
body — Required $ref: "#/definitions/images_image_variant_definition"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "id": "hero",
    "options": {
      "fit": "scale-down",
      "metadata": "none",
      "width": 1366,
      "height": 768
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a variant — cloudflare.cloudflare-images-variants-delete-a-variant

Delete a CF Images variant. This will purge the cache for all images associated with the variant.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.variant_id — Required $ref: "#/definitions/images_image_variant_identifier"
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "variant_id": "hero",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Variant details — cloudflare.cloudflare-images-variants-variant-details

Fetch details for a CF Images variant.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.variant_id — Required $ref: "#/definitions/images_image_variant_identifier"
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "variant_id": "hero",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a variant — cloudflare.cloudflare-images-variants-update-a-variant

Update a CF Images variant. This will purge the cache for all images associated with the variant.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.variant_id — Required $ref: "#/definitions/images_image_variant_identifier"
path.account_id — Required $ref: "#/definitions/images_account_identifier"
body — Required $ref: "#/definitions/images_image_variant_patch_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "variant_id": "hero",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "options": {
      "fit": "scale-down",
      "metadata": "none",
      "width": 1366,
      "height": 768
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List images V2 — cloudflare.cloudflare-images-list-images-v2

List up to 10000 images from CF Images, with up to 1000 results per page. Use the optional parameters below to get a specific range of images. Pagination is supported via continuation_token.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
query object Optional additionalProperties: false
query.continuation_token — Optional $ref: "#/definitions/images_images_list_continuation_token"
query.per_page number Optional Number of items per page default: 1000; minimum: 10; maximum: 10000
query.sort_order string Optional Sorting order by upload time enum: ["asc","desc"]; default: "desc"
query.creator string | null Optional Internal user ID set within the creator field. Setting to empty string "" will return images where creator field is not set
query.meta.<field>[<operator>] string Optional Optional metadata filter(s). Multiple filters can be combined with AND logic. Operators: - eq, eq:string, eq:number, eq:boolean - Exact match - gt, gt:number - Greater than (number only) - gte, gte:number - Greater than or equal (number only) - lt, lt:number - Less than (number only) - lte, lte:number - Less than or equal (number only) - in, in:string, in:number - Match any value in pipe-separated list Examples: - meta.status[eq]=active - meta.priority[eq:number]=5 - meta.enabled[eq:boolean]=true - meta.priority[gte:number]=1 - meta.score[lt:number]=100 - meta.region[in]=us-east&#124;us-west&#124;eu-west Note: Filter consistency is not validated. Contradictory filters (e.g., meta.priority[eq:number]=5&amp;meta.priority[lte:number]=3) will return zero results.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List image metadata keys — cloudflare.cloudflare-images-list-metadata-keys

Lists filterable metadata keys used by images for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List sourcing kit migrations — cloudflare.cloudflare-images-sourcingkit-list-migrations

List CF Images imports.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
query object Optional additionalProperties: false
query.offset integer Optional Number of items to skip before returning results. default: 0; minimum: 0
query.limit integer Optional Maximum number of items to return. default: 25; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a sourcing kit migration — cloudflare.cloudflare-images-sourcingkit-create-migration

Create a pending CF Images import from a configured source.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
body — Required $ref: "#/definitions/images_sourcingkit_migration_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "sourceId": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a sourcing kit migration — cloudflare.cloudflare-images-sourcingkit-delete-migration

Delete a completed, failed, or aborted CF Images import.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.migration_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "migration_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get sourcing kit migration — cloudflare.cloudflare-images-sourcingkit-get-migration

Get the configuration and status of a CF Images import.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.migration_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "migration_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get migration progress — cloudflare.cloudflare-images-sourcingkit-get-migration-progress

Get progress and object counts for a CF Images import.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.migration_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "migration_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Abort a migration — cloudflare.cloudflare-images-sourcingkit-abort-migration

Abort a running CF Images import. Already imported images will remain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.migration_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "migration_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a migration — cloudflare.cloudflare-images-sourcingkit-start-migration

Start a pending CF Images import.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.migration_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "migration_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List migration logs — cloudflare.cloudflare-images-sourcingkit-list-migration-logs

List log entries for a CF Images import.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.migration_id — Required $ref: "#/definitions/images_sourcingkit_identifier"
query object Optional additionalProperties: false
query.offset integer Optional Number of items to skip before returning results. default: 0; minimum: 0
query.limit integer Optional Maximum number of items to return. default: 25; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "migration_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List sourcing kit sources — cloudflare.cloudflare-images-sourcingkit-list-sources

List sources configured for CF Images imports.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
query object Optional additionalProperties: false
query.offset integer Optional Number of items to skip before returning results. default: 0; minimum: 0
query.limit integer Optional Maximum number of items to return. default: 25; minimum: 1; maximum: 100
query.name string Optional Filter sources by name (partial match).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a sourcing kit source — cloudflare.cloudflare-images-sourcingkit-create-source

Configure an S3 source for CF Images imports.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
body — Required $ref: "#/definitions/images_sourcingkit_source_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "my-s3-bucket",
    "bucket": "my-images-bucket",
    "vendor": "s3",
    "secret": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Precheck source connectivity — cloudflare.cloudflare-images-sourcingkit-precheck-source-connectivity

Check S3 credentials without saving a source.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
body — Required $ref: "#/definitions/images_sourcingkit_connectivity_precheck_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "bucket": "example",
    "vendor": "s3",
    "secret": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a sourcing kit source — cloudflare.cloudflare-images-sourcingkit-delete-source

Delete a source configured for CF Images imports. Sources used by active imports cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.source_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "source_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get sourcing kit source — cloudflare.cloudflare-images-sourcingkit-get-source

Get details of a source configured for CF Images imports.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.source_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "source_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a sourcing kit source — cloudflare.cloudflare-images-sourcingkit-update-source

Rename a source configured for CF Images imports.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.source_id — Required $ref: "#/definitions/images_sourcingkit_identifier"
body — Required $ref: "#/definitions/images_sourcingkit_source_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "source_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  },
  "body": {
    "name": "my-renamed-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get source connectivity status — cloudflare.cloudflare-images-sourcingkit-get-source-connectivity

Check whether a source can still access its S3 bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/images_account_identifier"
path.source_id — Required $ref: "#/definitions/images_sourcingkit_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "source_id": "5ca167e6-4e40-4ced-a209-ca1b9dd6a265"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all targets — cloudflare.infra-targets-list

Lists and sorts an account's targets. Filters are optional and are ANDed together.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
query object Optional additionalProperties: false
query.hostname string | null Optional Hostname of a target
query.hostname_contains string | null Optional Partial match to the hostname of a target
query.virtual_network_id string | null Optional Private virtual network identifier of the target format: "uuid"
query.ip_v4 string | null Optional IPv4 address of the target
query.ip_v6 string | null Optional IPv6 address of the target
query.created_before string | null Optional Date and time at which the target was created before (inclusive) format: "date-time"
query.created_after string | null Optional Date and time at which the target was created after (inclusive) format: "date-time"
query.modified_before string | null Optional Date and time at which the target was modified before (inclusive) format: "date-time"
query.modified_after string | null Optional Date and time at which the target was modified after (inclusive) format: "date-time"
query.ips array Optional Filters for targets that have any of the following IP addresses. Specify ips multiple times in query parameter to build list of candidates.
query.ips[] string Optional
query.target_ids array Optional Filters for targets that have any of the following UUIDs. Specify target_ids multiple times in query parameter to build list of candidates.
query.target_ids[] string Optional format: "uuid"
query.ip_like string | null Optional Filters for targets whose IP addresses look like the specified string. Supports * as a wildcard character
query.ipv4_start string | null Optional Defines an IPv4 filter range's starting value (inclusive). Requires ipv4_end to be specified as well.
query.ipv4_end string | null Optional Defines an IPv4 filter range's ending value (inclusive). Requires ipv4_start to be specified as well.
query.ipv6_start string | null Optional Defines an IPv6 filter range's starting value (inclusive). Requires ipv6_end to be specified as well.
query.ipv6_end string | null Optional Defines an IPv6 filter range's ending value (inclusive). Requires ipv6_start to be specified as well.
query.tag array Optional Filter by tag key:value pairs. Multiple tag params are AND'd. Format: tag=key:value (e.g., tag=environment:production). Key and value must both be non-empty; tag=:value and tag=key: return 400.
query.tag[] string Optional
query.page integer Optional Current page in the response default: 1; minimum: 1
query.per_page integer Optional Max amount of entries returned per page default: 1000; minimum: 1; maximum: 1000
query.order string Optional The field to sort by. enum: ["hostname","created_at"]
query.direction — Optional The sorting direction.
query.direction — Optional allOf[1]; $ref: "#/definitions/infra_SortingDirection"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new target — cloudflare.infra-targets-post

Creates a new infrastructure access target in the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
body object Required
body.hostname string Required A non-unique field that refers to a target. Case insensitive, maximum length of 255 characters, supports the use of special characters dash and period, does not support spaces, and must start and end with an alphanumeric character.
body.ip — Required $ref: "#/definitions/infra_IPInfo"
body.tags object | null Optional Optional tags to associate with the target. Keys and values are user-defined strings. additionalProperties: {"type":"string"}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "hostname": "infra-access-target",
    "ip": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new targets — cloudflare.infra-targets-put-batch

Adds one or more targets.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
body array Required
body[] object Optional
body[].hostname string Required A non-unique field that refers to a target. Case insensitive, maximum length of 255 characters, supports the use of special characters dash and period, does not support spaces, and must start and end with an alphanumeric character.
body[].ip — Required $ref: "#/definitions/infra_IPInfo"
body[].tags object | null Optional Optional tags to associate with the target. Keys and values are user-defined strings. additionalProperties: {"type":"string"}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete targets — cloudflare.infra-targets-delete-batch-post

Removes one or more targets.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
body object Required
body.target_ids array Required List of target IDs to bulk delete
body.target_ids[] — Optional $ref: "#/definitions/infra_TargetId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "target_ids": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace tags on existing targets — cloudflare.infra-targets-post-batch-tags

Replaces tags for one or more existing infrastructure access targets.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
body object Required
body.items array Required
body.items[] — Optional $ref: "#/definitions/infra_BatchReplaceTargetTagsItem"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "items": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete target — cloudflare.infra-targets-delete

Removes a single infrastructure access target by its ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
path.target_id — Required $ref: "#/definitions/infra_TargetId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "target_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get target — cloudflare.infra-targets-get

Fetches a single infrastructure access target by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
path.target_id — Required $ref: "#/definitions/infra_TargetId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "target_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update target — cloudflare.infra-targets-put

Updates an existing infrastructure access target by its ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/infra_AccountTag"
path.target_id — Required $ref: "#/definitions/infra_TargetId"
body object Required
body.hostname string Required A non-unique field that refers to a target. Case insensitive, maximum length of 255 characters, supports the use of special characters dash and period, does not support spaces, and must start and end with an alphanumeric character.
body.ip — Required $ref: "#/definitions/infra_IPInfo"
body.tags object | null Optional Optional tags to associate with the target. Keys and values are user-defined strings. additionalProperties: {"type":"string"}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "target_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
  },
  "body": {
    "hostname": "infra-access-target",
    "ip": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get ASN Overview. — cloudflare.asn-intelligence-get-asn-overview

Gets an overview of the Autonomous System Number (ASN) and a list of subnets for it.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asn — Required $ref: "#/definitions/intel_asn"
path.account_id — Required $ref: "#/definitions/intel_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asn": 1,
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get ASN Subnets — cloudflare.asn-intelligence-get-asn-subnets

Get ASN Subnets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asn — Required $ref: "#/definitions/intel_asn"
path.account_id — Required $ref: "#/definitions/intel_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asn": 1,
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Security Center Issues Types — cloudflare.get-security-center-issue-types

Lists all available issue types in Security Center, describing categories of security issues.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Passive DNS by IP — cloudflare.passive-dns-by-ip-get-passive-dns-by-ip

Gets a list of all the domains that have resolved to a specific IP address.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"
query object Optional additionalProperties: false
query.start_end_params — Optional $ref: "#/definitions/intel_start_end_params"
query.ipv4 string Optional
query.page number Optional Requested page within paginated list of results.
query.per_page number Optional Maximum number of results requested.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Domain Details — cloudflare.domain-intelligence-get-domain-details

Gets security details and statistics about a domain.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"
query object Optional additionalProperties: false
query.domain string Optional
query.skip_dns boolean Optional Skip DNS resolution lookups for faster response.
query.skip_ranking boolean Optional Skip the domain ranking lookup for faster responses. Defaults to false (ranking is included). Set to true to opt out — primarily used by callers like Cloudflare Radar that need to avoid a circular dependency when building the domain details page. Note: the bulk endpoint (/intel/domain/bulk) uses opposite defaults — see include_ranking there. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Domain History — cloudflare.domain-history-get-domain-history

Gets historical security threat and content categories currently and previously assigned to a domain.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"
query object Optional additionalProperties: false
query.domain string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Multiple Domain Details — cloudflare.domain-intelligence-get-multiple-domain-details

Returns security details and statistics about multiple domains in a single request.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"
query object Optional additionalProperties: false
query.domain array Optional Accepts multiple values like ?domain=cloudflare.com&amp;domain=example.com.
query.domain[] string Optional
query.include_ranking boolean Optional Whether to include domain ranking data in the response. Defaults to false — ranking lookups are expensive at bulk scale and most callers do not need them. Set to true to opt in. This parameter replaces the deprecated skip_ranking (see below). default: false
query.skip_ranking boolean Optional Deprecated. Previously controlled whether the ranking lookup was skipped (defaulted to false, meaning ranking ran). The endpoint's default behavior is being flipped — ranking is now opt-in via include_ranking=true — and this parameter will be silently ignored. Remove it from your callers and use include_ranking instead.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get indicator feeds owned by this account — cloudflare.custom-indicator-feeds-get-indicator-feeds

Retrieves details for all accessible custom threat indicator feeds.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new indicator feed — cloudflare.custom-indicator-feeds-create-indicator-feeds

Creates a new custom threat indicator feed for sharing threat intelligence data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
body — Required $ref: "#/definitions/custom-indicator-feeds_create_feed"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "description": "example feed description",
    "name": "example_feed_1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Grant permission to indicator feed — cloudflare.custom-indicator-feeds-add-permission

Grants access permissions for a custom threat indicator feed to other accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
body — Required $ref: "#/definitions/custom-indicator-feeds_permissions_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create indicator feed provider — cloudflare.custom-indicator-feeds-create-provider

Creates a new indicator feed provider for an account. Only available to Intel accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
body — Required $ref: "#/definitions/custom-indicator-feeds_create_provider_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "account_id": 12345,
    "name": "my_provider"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke permission to indicator feed — cloudflare.custom-indicator-feeds-remove-permission

Revokes access permissions for a custom threat indicator feed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
body — Required $ref: "#/definitions/custom-indicator-feeds_permissions_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List indicator feed permissions — cloudflare.custom-indicator-feeds-view-permissions

Lists current access permissions for custom threat indicator feeds.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get indicator feed metadata — cloudflare.custom-indicator-feeds-get-indicator-feed-metadata

Retrieves details for a specific custom threat indicator feed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
path.feed_id — Required $ref: "#/definitions/custom-indicator-feeds_feed_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "feed_id": 12
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update indicator feed metadata — cloudflare.custom-indicator-feeds-update-indicator-feed-metadata

Revises details for a specific custom threat indicator feed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
path.feed_id — Required $ref: "#/definitions/custom-indicator-feeds_feed_id"
body — Required $ref: "#/definitions/custom-indicator-feeds_update_public_field_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "feed_id": 12
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get indicator feed data — cloudflare.custom-indicator-feeds-get-indicator-feed-data

Retrieves the raw data entries in a custom threat indicator feed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
path.feed_id — Required $ref: "#/definitions/custom-indicator-feeds_feed_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "feed_id": 12
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Download indicator feed data — cloudflare.custom-indicator-feeds-download-indicator-feed-data

Downloads the content of a custom threat indicator feed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
path.feed_id — Required $ref: "#/definitions/custom-indicator-feeds_feed_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "feed_id": 12
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get indicator feed upload status — cloudflare.custom-indicator-feeds-get-upload-status

Polls an asynchronously accepted upload. Continue polling after the recommended poll_after_seconds delay until status is Unified or Error. Unified is returned only after the durable loader finishes.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/custom-indicator-feeds_identifier"
path.feed_id — Required $ref: "#/definitions/custom-indicator-feeds_feed_id"
path.upload_id integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "feed_id": 12,
    "upload_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get IP Overview — cloudflare.ip-intelligence-get-ip-overview

Gets the geolocation, ASN, infrastructure type of the ASN, and any security threat categories of an IP address. Must provide ip query parameters. For example, /intel/ip?ipv4=1.1.1.1 or /intel/ip?ipv6=2001:db8::1.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"
query object Optional additionalProperties: false
query.ipv4 string Optional
query.ipv6 string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Available IP Lists — cloudflare.ip-list-get-ip-lists

Returns a list of available IP list categories (e.g., anonymizer, botnetcc, malware, tor, vpn, open_proxies). This endpoint provides metadata about which IP lists are available in the system.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Miscategorization — cloudflare.miscategorization-create-miscategorization

Allows you to submit requests to change a domain’s category.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"
body — Required $ref: "#/definitions/intel_miscategorization"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List sinkholes owned by this account — cloudflare.sinkhole-config-list-sinkholes

Lists sinkholes owned by the account for redirecting malicious traffic.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The unique identifier for the Cloudflare account. $ref: "#/definitions/intel-sinkholes_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new sinkhole for your account — cloudflare.sinkhole-config-create-sinkhole

Create a new sinkhole. Logs of large request bodies will be truncated, but the full request body can be recorded in R2. If you wish to record large request bodies in R2, include the R2 key ID, key secret, and bucket name in the request body.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The unique identifier for the Cloudflare account. $ref: "#/definitions/intel-sinkholes_identifier"
body — Required $ref: "#/definitions/intel-sinkholes_sinkhole_create_params"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a sinkhole — cloudflare.sinkhole-config-delete-sinkhole

Delete the specified sinkhole. The sinkhole must not have any active ingress rules defined. A 409 response code indicates that this condition is not met.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The unique identifier for the Cloudflare account. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a sinkhole — cloudflare.sinkhole-config-get-sinkhole

Get the specified sinkhole by its unique identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The unique identifier for the Cloudflare account. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a sinkhole — cloudflare.sinkhole-config-update-sinkhole

Replaces the name or R2 configuration of the specified sinkhole. This is a full replacement. All fields, including r2_secret, must be re-supplied. Omitting r2_secret overwrites the stored value with an empty string.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The unique identifier for the Cloudflare account. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.
body — Required $ref: "#/definitions/intel-sinkholes_sinkhole_create_params"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List ingresses for a sinkhole — cloudflare.sinkhole-config-list-sinkhole-ingresses

Returns all ingress rules associated with the specified sinkhole.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The unique identifier for the Cloudflare account. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get URL Intelligence — cloudflare.url-intelligence-get-url-intelligence

Gets security information about a URL, including content categories and risk types. The URL must be provided as a query parameter.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/intel_identifier"
query object Required additionalProperties: false
query.url string Required The URL to look up.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "url": "https://example.com/path"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get WHOIS Record — cloudflare.whois-record-get-whois-record

Retrieves WHOIS registration data for a domain, including registrant and nameserver information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudforce-one-whois_identifier"
query object Optional additionalProperties: false
query.domain string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Toggle PDF Invoices — cloudflare.account-billing-toggle-pdf-invoices

Toggles PDF invoice generation for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body object Required
body.toggle boolean Optional Whether to enable or disable PDF invoice generation.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List K2 streams — cloudflare.getv4accountsbyaccount_idk2streams

List or filter K2 streams in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-account-id"
query object Optional additionalProperties: false
query.name string Optional Filters K2 streams by name using a case-insensitive substring. minLength: 1; maxLength: 128
query.page integer Optional default: 1; minimum: 1
query.per_page integer Optional default: 25; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create K2 stream — cloudflare.postv4accountsbyaccount_idk2streams

Create a new K2 stream. HTTP is disabled when http is omitted. Enabled HTTP requires authentication and allows all origins unless authentication or cors say otherwise. At least one input must be enabled.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-account-id"
body — Required $ref: "#/definitions/cloudflare-k2_CreateK2StreamRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "my_k2_stream"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete K2 stream — cloudflare.deletev4accountsbyaccount_idk2streamsbystream_id

Delete a K2 stream in an account. Deleting a stream that does not exist also succeeds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-account-id"
path.stream_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-stream-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "stream_id": "053e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get K2 stream — cloudflare.getv4accountsbyaccount_idk2streamsbystream_id

Get K2 stream details.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-account-id"
path.stream_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-stream-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "stream_id": "053e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List subscriptions with consumer lag — cloudflare.getv4accountsbyaccount_idk2streamsbystream_idsubscriptions

Lists every subscription on one stream, oldest first. Lag uses committed positions, not reserved read positions. A failed tail observation preserves subscription metadata and returns unavailable lag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-account-id"
path.stream_id — Required $ref: "#/definitions/cloudflare-k2_workers-k2-stream-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "stream_id": "053e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Account Load Balancers — cloudflare.account-load-balancers-list-account-load-balancers

List configured account-scoped load balancers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Monitor Groups — cloudflare.account-load-balancer-monitor-groups-list-monitor-groups

List configured monitor groups.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Monitor Group — cloudflare.account-load-balancer-monitor-groups-create-monitor-group

Create a new monitor group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required $ref: "#/definitions/load-balancing_monitor-group"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "description": "Primary datacenter monitors",
    "members": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Monitor Group — cloudflare.account-load-balancer-monitor-groups-delete-monitor-group

Delete a configured monitor group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_group_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_group_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Monitor Group Details — cloudflare.account-load-balancer-monitor-groups-monitor-group-details

Fetch a single configured monitor group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_group_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_group_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Monitor Group — cloudflare.account-load-balancer-monitor-groups-patch-monitor-group

Apply changes to an existing monitor group, overwriting the supplied properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_group_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required $ref: "#/definitions/load-balancing_monitor-group"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_group_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "description": "Primary datacenter monitors",
    "members": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Monitor Group — cloudflare.account-load-balancer-monitor-groups-update-monitor-group

Modify a configured monitor group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_group_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required $ref: "#/definitions/load-balancing_monitor-group"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_group_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "description": "Primary datacenter monitors",
    "members": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Monitor Group References — cloudflare.account-load-balancer-monitor-groups-list-monitor-group-references

Get the list of resources that reference the provided monitor group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_group_id — Required $ref: "#/definitions/load-balancing_identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_group_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Monitors — cloudflare.account-load-balancer-monitors-list-monitors

List configured monitors for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Monitor — cloudflare.account-load-balancer-monitors-create-monitor

Create a configured monitor.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Monitor — cloudflare.account-load-balancer-monitors-delete-monitor

Delete a configured monitor.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Monitor Details — cloudflare.account-load-balancer-monitors-monitor-details

Fetch a single configured monitor for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Monitor — cloudflare.account-load-balancer-monitors-patch-monitor

Apply changes to an existing monitor, overwriting the supplied properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Monitor — cloudflare.account-load-balancer-monitors-update-monitor

Modify a configured monitor.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview Monitor — cloudflare.account-load-balancer-monitors-preview-monitor

Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Monitor References — cloudflare.account-load-balancer-monitors-list-monitor-references

Get the list of resources that reference the provided monitor.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Pools — cloudflare.account-load-balancer-pools-list-pools

List configured pools.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
query object Optional additionalProperties: false
query.monitor string Optional The ID of the Monitor to use for checking the health of origins within this pool.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Pools — cloudflare.account-load-balancer-pools-patch-pools

Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending name. Returns the list of affected pools. Supports the standard pagination query parameters, either limit/offset or per_page/page.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body object Required
body.notification_email — Optional $ref: "#/definitions/load-balancing_patch_pools_notification_email"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Pool — cloudflare.account-load-balancer-pools-create-pool

Create a new pool.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body object Required
body.description — Optional $ref: "#/definitions/load-balancing_schemas-description"
body.enabled — Optional $ref: "#/definitions/load-balancing_enabled"
body.latitude — Optional $ref: "#/definitions/load-balancing_latitude"
body.load_shedding — Optional $ref: "#/definitions/load-balancing_load_shedding"
body.longitude — Optional $ref: "#/definitions/load-balancing_longitude"
body.minimum_origins — Optional $ref: "#/definitions/load-balancing_minimum_origins"
body.monitor — Optional $ref: "#/definitions/load-balancing_monitor_id"
body.monitor_group — Optional $ref: "#/definitions/load-balancing_monitor_group_id"
body.name — Required $ref: "#/definitions/load-balancing_name"
body.notification_email — Optional $ref: "#/definitions/load-balancing_notification_email"
body.notification_filter — Optional $ref: "#/definitions/load-balancing_notification_filter"
body.origin_steering — Optional $ref: "#/definitions/load-balancing_origin_steering"
body.origins — Required $ref: "#/definitions/load-balancing_origins"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "origins": [],
    "name": "primary-dc-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Pool — cloudflare.account-load-balancer-pools-delete-pool

Delete a configured pool.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pool Details — cloudflare.account-load-balancer-pools-pool-details

Fetch a single configured pool.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Pool — cloudflare.account-load-balancer-pools-patch-pool

Apply changes to an existing pool, overwriting the supplied properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body object Required
body.check_regions — Optional $ref: "#/definitions/load-balancing_check_regions"
body.description — Optional $ref: "#/definitions/load-balancing_schemas-description"
body.disabled_at — Optional $ref: "#/definitions/load-balancing_schemas-disabled_at"
body.enabled — Optional $ref: "#/definitions/load-balancing_enabled"
body.health_sources — Optional $ref: "#/definitions/load-balancing_health_sources"
body.latitude — Optional $ref: "#/definitions/load-balancing_latitude"
body.load_shedding — Optional $ref: "#/definitions/load-balancing_load_shedding"
body.longitude — Optional $ref: "#/definitions/load-balancing_longitude"
body.minimum_origins — Optional $ref: "#/definitions/load-balancing_minimum_origins"
body.monitor — Optional $ref: "#/definitions/load-balancing_monitor_id"
body.monitor_group — Optional $ref: "#/definitions/load-balancing_monitor_group_id"
body.name — Optional $ref: "#/definitions/load-balancing_name"
body.notification_email — Optional $ref: "#/definitions/load-balancing_notification_email"
body.notification_filter — Optional $ref: "#/definitions/load-balancing_notification_filter"
body.origin_steering — Optional $ref: "#/definitions/load-balancing_origin_steering"
body.origins — Optional $ref: "#/definitions/load-balancing_origins"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Pool — cloudflare.account-load-balancer-pools-update-pool

Modify a configured pool.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body object Required
body.check_regions — Optional $ref: "#/definitions/load-balancing_check_regions"
body.description — Optional $ref: "#/definitions/load-balancing_schemas-description"
body.disabled_at — Optional $ref: "#/definitions/load-balancing_schemas-disabled_at"
body.enabled — Optional $ref: "#/definitions/load-balancing_enabled"
body.health_sources — Optional $ref: "#/definitions/load-balancing_health_sources"
body.latitude — Optional $ref: "#/definitions/load-balancing_latitude"
body.load_shedding — Optional $ref: "#/definitions/load-balancing_load_shedding"
body.longitude — Optional $ref: "#/definitions/load-balancing_longitude"
body.minimum_origins — Optional $ref: "#/definitions/load-balancing_minimum_origins"
body.monitor — Optional $ref: "#/definitions/load-balancing_monitor_id"
body.monitor_group — Optional $ref: "#/definitions/load-balancing_monitor_group_id"
body.name — Required $ref: "#/definitions/load-balancing_name"
body.notification_email — Optional $ref: "#/definitions/load-balancing_notification_email"
body.notification_filter — Optional $ref: "#/definitions/load-balancing_notification_filter"
body.origin_steering — Optional $ref: "#/definitions/load-balancing_origin_steering"
body.origins — Required $ref: "#/definitions/load-balancing_origins"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "origins": [],
    "name": "primary-dc-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pool Health Details — cloudflare.account-load-balancer-pools-pool-health-details

Fetch the latest pool health status for a single pool.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview Pool — cloudflare.account-load-balancer-pools-preview-pool

Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Pool References — cloudflare.account-load-balancer-pools-list-pool-references

Get the list of resources that reference the provided pool.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview Result — cloudflare.account-load-balancer-monitors-preview-result

Get the result of a previous preview operation using the provided preview_id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.preview_id — Required $ref: "#/definitions/load-balancing_schemas-preview_id"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "preview_id": "p1aba936b94213e5b8dca0c0dbf1f9cc",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Regions — cloudflare.load-balancer-regions-list-regions

List all region mappings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
query object Optional additionalProperties: false
query.subdivision_code — Optional $ref: "#/definitions/load-balancing_subdivision_code_a2"
query.subdivision_code_a2 — Optional $ref: "#/definitions/load-balancing_subdivision_code_a2"
query.country_code_a2 string Optional Two-letter alpha-2 country code followed in ISO 3166-1.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Region — cloudflare.load-balancer-regions-get-region

Get a single region mapping.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.region_id — Required $ref: "#/definitions/load-balancing_region_code"
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "region_id": "WNAM",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search Resources — cloudflare.account-load-balancer-search-search-resources

Search for Load Balancing resources.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
query object Optional additionalProperties: false
query.query string Optional Search query term. default: ""
query.references string Optional The type of references to include. "*" to include both referral and referrer references. "" to not include any reference information. enum: ["","*","referral","referrer"]; default: ""
query.page number Optional minimum: 1
query.per_page number Optional default: 25; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Load Balancer Usage — cloudflare.account-load-balancers-list-load-balancer-usage

Get current load balancer resource usage counts for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Account Load Balancer — cloudflare.account-load-balancers-delete-account-load-balancer

Delete a configured account-scoped load balancer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
path.load_balancer_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "load_balancer_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Account Load Balancer Details — cloudflare.account-load-balancers-account-load-balancer-details

Fetch a single configured account-scoped load balancer.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
path.load_balancer_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "load_balancer_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Account Load Balancer — cloudflare.account-load-balancers-patch-account-load-balancer

Apply changes to an existing account-scoped load balancer, overwriting the supplied properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/load-balancing_components-schemas-identifier"
path.load_balancer_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_load-balancer-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "load_balancer_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List fields — cloudflare.get-accounts-account_id-logpush-datasets-dataset_id-fields

Lists all fields available for a dataset. The response result is. an object with key-value pairs, where keys are field names, and values are descriptions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dataset_id — Required $ref: "#/definitions/logpush_dataset"
path.account_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dataset_id": "http_requests",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Logpush jobs for a dataset — cloudflare.get-accounts-account_id-logpush-datasets-dataset_id-jobs

Lists Logpush jobs for an account for a dataset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dataset_id — Required $ref: "#/definitions/logpush_dataset"
path.account_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dataset_id": "http_requests",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Logpush jobs — cloudflare.get-accounts-account_id-logpush-jobs

Lists Logpush jobs for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Logpush job — cloudflare.post-accounts-account_id-logpush-jobs

Creates a new Logpush job for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.dataset — Optional $ref: "#/definitions/logpush_dataset"
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"
body.enabled — Optional $ref: "#/definitions/logpush_enabled"
body.filter — Optional $ref: "#/definitions/logpush_filter"
body.filter_attack_traffic — Optional $ref: "#/definitions/logpush_filter_attack_traffic"
body.frequency — Optional $ref: "#/definitions/logpush_frequency"
body.kind — Optional $ref: "#/definitions/logpush_kind"
body.logpull_options — Optional $ref: "#/definitions/logpush_logpull_options"
body.max_upload_bytes — Optional $ref: "#/definitions/logpush_max_upload_bytes"
body.max_upload_interval_seconds — Optional $ref: "#/definitions/logpush_max_upload_interval_seconds"
body.max_upload_records — Optional $ref: "#/definitions/logpush_max_upload_records"
body.name — Optional $ref: "#/definitions/logpush_name"
body.output_options — Optional $ref: "#/definitions/logpush_output_options"
body.ownership_challenge — Optional $ref: "#/definitions/logpush_ownership_challenge"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "dataset": "gateway_dns",
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "enabled": false,
    "filter": "{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}",
    "kind": "",
    "max_upload_bytes": 5000000,
    "max_upload_interval_seconds": 30,
    "max_upload_records": 1000,
    "name": "example.com",
    "output_options": {
      "CVE-2021-44228": false,
      "batch_prefix": "",
      "batch_suffix": "",
      "field_delimiter": ",",
      "field_names": [
        "Datetime",
        "DstIP",
        "SrcIP"
      ],
      "output_type": "ndjson",
      "record_delimiter": "",
      "record_prefix": "{",
      "record_suffix": "}\n",
      "sample_rate": 1,
      "timestamp_format": "unixnano"
    },
    "ownership_challenge": "00000000000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Logpush job — cloudflare.delete-accounts-account_id-logpush-jobs-job_id

Deletes a Logpush job.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.job_id — Required $ref: "#/definitions/logpush_id"
path.account_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "job_id": 1,
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Logpush job details — cloudflare.get-accounts-account_id-logpush-jobs-job_id

Gets the details of a Logpush job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.job_id — Required $ref: "#/definitions/logpush_id"
path.account_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "job_id": 1,
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Logpush job — cloudflare.put-accounts-account_id-logpush-jobs-job_id

Updates a Logpush job.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.job_id — Required $ref: "#/definitions/logpush_id"
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Optional $ref: "#/definitions/logpush_destination_conf"
body.enabled — Optional $ref: "#/definitions/logpush_enabled"
body.filter — Optional $ref: "#/definitions/logpush_filter"
body.filter_attack_traffic — Optional $ref: "#/definitions/logpush_filter_attack_traffic"
body.frequency — Optional $ref: "#/definitions/logpush_frequency"
body.kind — Optional $ref: "#/definitions/logpush_kind"
body.logpull_options — Optional $ref: "#/definitions/logpush_logpull_options"
body.max_upload_bytes — Optional $ref: "#/definitions/logpush_max_upload_bytes"
body.max_upload_interval_seconds — Optional $ref: "#/definitions/logpush_max_upload_interval_seconds"
body.max_upload_records — Optional $ref: "#/definitions/logpush_max_upload_records"
body.name — Optional $ref: "#/definitions/logpush_name"
body.output_options — Optional $ref: "#/definitions/logpush_output_options"
body.ownership_challenge — Optional $ref: "#/definitions/logpush_ownership_challenge"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "job_id": 1,
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "enabled": false,
    "filter": "{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}",
    "kind": "",
    "max_upload_bytes": 5000000,
    "max_upload_interval_seconds": 30,
    "max_upload_records": 1000,
    "output_options": {
      "CVE-2021-44228": false,
      "batch_prefix": "",
      "batch_suffix": "",
      "field_delimiter": ",",
      "field_names": [
        "Datetime",
        "DstIP",
        "SrcIP"
      ],
      "output_type": "ndjson",
      "record_delimiter": "",
      "record_prefix": "{",
      "record_suffix": "}\n",
      "sample_rate": 1,
      "timestamp_format": "unixnano"
    },
    "ownership_challenge": "00000000000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get ownership challenge — cloudflare.post-accounts-account_id-logpush-ownership

Gets a new ownership challenge sent to your destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate ownership challenge — cloudflare.post-accounts-account_id-logpush-ownership-validate

Validates ownership challenge of the destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"
body.ownership_challenge — Required $ref: "#/definitions/logpush_ownership_challenge"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "ownership_challenge": "00000000000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List transformers — cloudflare.get-accounts-account_id-logpush-transformers

Lists all custom log transformers for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create transformer — cloudflare.post-accounts-account_id-logpush-transformers

Creates a new custom log transformer for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body — Required $ref: "#/definitions/logpush_transformer_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "redact-pii",
    "code": "SELECT ClientIP, RayID FROM http_requests"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview transformer — cloudflare.post-accounts-account_id-logpush-transformers-preview

Executes a SQL transformer against a single input record and returns the transformed output. This is a stateless endpoint — nothing is persisted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body — Required $ref: "#/definitions/logpush_transformer_preview_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "sql": "SELECT ClientIP, RayID FROM http_requests",
    "input": {
      "ClientIP": "198.51.100.1",
      "ClientRequestHost": "example.com",
      "EdgeStartTimestamp": 1722513600000000000,
      "RayID": "abcdef1234567890"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete transformer — cloudflare.delete-accounts-account_id-logpush-transformers-transformer_id

Deletes a custom log transformer. Returns 409 Conflict if any active logpush jobs reference the transformer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
path.transformer_id — Required $ref: "#/definitions/logpush_transformer_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "transformer_id": 42
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get transformer — cloudflare.get-accounts-account_id-logpush-transformers-transformer_id

Gets a single custom log transformer by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
path.transformer_id — Required $ref: "#/definitions/logpush_transformer_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "transformer_id": 42
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update transformer — cloudflare.put-accounts-account_id-logpush-transformers-transformer_id

Updates an existing custom log transformer. When code is provided, the SQL query is validated and a new version is created. When code is omitted, only the name and description are updated. Omitting description clears the existing description.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
path.transformer_id — Required $ref: "#/definitions/logpush_transformer_identifier"
body — Required $ref: "#/definitions/logpush_transformer_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "transformer_id": 42
  },
  "body": {
    "name": "redact-pii"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get transformer content — cloudflare.get-accounts-account_id-logpush-transformers-transformer_id-content

Returns the SQL query content for a transformer. Without query params, returns the latest version. With version_id, returns the specified version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
path.transformer_id — Required $ref: "#/definitions/logpush_transformer_identifier"
query object Optional additionalProperties: false
query.version_id integer Optional Specific version ID to retrieve. When omitted, the latest version is returned.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "transformer_id": 42
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List transformer versions — cloudflare.get-accounts-account_id-logpush-transformers-transformer_id-versions

Returns version metadata for a transformer, newest first. Each version corresponds to a SQL query update.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
path.transformer_id — Required $ref: "#/definitions/logpush_transformer_identifier"
query object Optional additionalProperties: false
query.limit integer Optional Maximum number of versions to return. default: 10; minimum: 1; maximum: 10

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "transformer_id": 42
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate destination — cloudflare.delete-accounts-account_id-logpush-validate-destination

Validates destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check destination exists — cloudflare.delete-accounts-account_id-logpush-validate-destination-exists

Checks if there is an existing job with a destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate origin — cloudflare.post-accounts-account_id-logpush-validate-origin

Validates logpull origin with logpull_options.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.logpull_options — Required $ref: "#/definitions/logpush_logpull_options"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account audit logs (Version 2) — cloudflare.audit-logs-v2-get-account-audit-logs

Gets a list of audit logs for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The unique id that identifies the account.
query object Required additionalProperties: false
query.account_name array Optional Filters by the account name.
query.account_name[] string Optional
query.action_result array Optional Filters by whether the action was successful or not.
query.action_result[] string Optional enum: ["success","failure"]
query.action_type array Optional Filters by the action type.
query.action_type[] string Optional enum: ["create","delete","view","update"]
query.actor_context array Optional Filters by the actor context. - api: The action was performed through the API. The specific credential type was not recorded. - api_key: The action was authenticated with a Cloudflare Global API Key. - api_token: The action was authenticated with an API token. - dash: The action was performed through the Cloudflare dashboard. - oauth: The action was authenticated with an OAuth token. - origin_ca_key: The action was authenticated with an Origin CA key.
query.actor_context[] string Optional enum: ["api","api_key","api_token","dash","oauth","origin_ca_key"]
query.actor_email array Optional Filters by the actor's email address.
query.actor_email[] string Optional format: "email"
query.actor_id array Optional Filters by the actor ID. This can be either the Account ID or User ID.
query.actor_id[] string Optional
query.actor_ip_address array Optional The IP address where the action was initiated.
query.actor_ip_address[] string Optional
query.actor_token_id array Optional Filters by the API token ID when the actor context is an api_token or oauth.
query.actor_token_id[] string Optional
query.actor_token_name array Optional Filters by the API token name when the actor context is an api_token or oauth.
query.actor_token_name[] string Optional
query.actor_type array Optional Filters by the actor type.
query.actor_type[] string Optional enum: ["account","cloudflare_admin","delegated_service","system","user"]
query.audit_log_id array Optional Finds a specific log by its ID.
query.audit_log_id[] string Optional
query.id array Optional Finds a specific log by its ID.
query.id[] string Optional
query.raw_cf_ray_id array Optional Filters by the response CF Ray ID.
query.raw_cf_ray_id[] string Optional
query.raw_method array Optional The HTTP method for the API call.
query.raw_method[] string Optional
query.raw_status_code array Optional The response status code that was returned.
query.raw_status_code[] integer Optional
query.raw_uri array Optional Filters by the request URI.
query.raw_uri[] string Optional
query.resource_id array Optional Filters by the resource ID.
query.resource_id[] string Optional
query.resource_product array Optional Filters audit logs by the Cloudflare product associated with the changed resource.
query.resource_product[] string Optional
query.resource_type array Optional Filters audit logs based on the unique type of resource changed by the action.
query.resource_type[] string Optional
query.resource_scope array Optional Filters by the resource scope, specifying whether the resource is associated with an user, an account, a zone, or a membership.
query.resource_scope[] string Optional enum: ["accounts","user","zones","memberships"]
query.product_category array Optional Filters audit logs by one or more predefined product categories. Each product category expands into a curated set of resource_product values and is unioned with any explicit resource_product filter. Matched case-insensitively; unknown product categories return 400. Repeatable. Use the audit log product categories endpoint to discover the available values.
query.product_category[] string Optional
query.zone_id array Optional Filters by the zone ID.
query.zone_id[] string Optional
query.zone_name array Optional Filters by the zone name associated with the change.
query.zone_name[] string Optional
query.account_name.not array Optional Filters out audit logs by the account name.
query.account_name.not[] string Optional
query.action_result.not array Optional Filters out audit logs by whether the action was successful or not.
query.action_result.not[] string Optional enum: ["success","failure"]
query.action_type.not array Optional Filters out audit logs by the action type.
query.action_type.not[] string Optional enum: ["create","delete","view","update"]
query.actor_context.not array Optional Filters out audit logs by the actor context. - api: The action was performed through the API. The specific credential type was not recorded. - api_key: The action was authenticated with a Cloudflare Global API Key. - api_token: The action was authenticated with an API token. - dash: The action was performed through the Cloudflare dashboard. - oauth: The action was authenticated with an OAuth token. - origin_ca_key: The action was authenticated with an Origin CA key.
query.actor_context.not[] string Optional enum: ["api","api_key","api_token","dash","oauth","origin_ca_key"]
query.actor_email.not array Optional Filters out audit logs by the actor's email address.
query.actor_email.not[] string Optional format: "email"
query.actor_id.not array Optional Filters out audit logs by the actor ID. This can be either the Account ID or User ID.
query.actor_id.not[] string Optional
query.actor_ip_address.not array Optional Filters out audit logs IP address where the action was initiated.
query.actor_ip_address.not[] string Optional
query.actor_token_id.not array Optional Filters out audit logs by the API token ID when the actor context is an api_token or oauth.
query.actor_token_id.not[] string Optional
query.actor_token_name.not array Optional Filters out audit logs by the API token name when the actor context is an api_token or oauth.
query.actor_token_name.not[] string Optional
query.actor_type.not array Optional Filters out audit logs by the actor type.
query.actor_type.not[] string Optional enum: ["account","cloudflare_admin","delegated_service","system","user"]
query.audit_log_id.not array Optional Filters out audit logs by their IDs.
query.audit_log_id.not[] string Optional
query.id.not array Optional Filters out audit logs by their IDs.
query.id.not[] string Optional
query.raw_cf_ray_id.not array Optional Filters out audit logs by the response CF Ray ID.
query.raw_cf_ray_id.not[] string Optional
query.raw_method.not array Optional Filters out audit logs by the HTTP method for the API call.
query.raw_method.not[] string Optional
query.raw_status_code.not array Optional Filters out audit logs by the response status code that was returned.
query.raw_status_code.not[] integer Optional
query.raw_uri.not array Optional Filters out audit logs by the request URI.
query.raw_uri.not[] string Optional
query.resource_id.not array Optional Filters out audit logs by the resource ID.
query.resource_id.not[] string Optional
query.resource_product.not array Optional Filters out audit logs by the Cloudflare product associated with the changed resource.
query.resource_product.not[] string Optional
query.resource_type.not array Optional Filters out audit logs based on the unique type of resource changed by the action.
query.resource_type.not[] string Optional
query.resource_scope.not array Optional Filters out audit logs by the resource scope, specifying whether the resource is associated with an user, an account, a zone, or a membership.
query.resource_scope.not[] string Optional enum: ["accounts","user","zones","memberships"]
query.zone_id.not array Optional Filters out audit logs by the zone ID.
query.zone_id.not[] string Optional
query.zone_name.not array Optional Filters out audit logs by the zone name associated with the change.
query.zone_name.not[] string Optional
query.since string Required Limits the returned results to logs newer than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.before string Required Limits the returned results to logs older than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.direction string Optional Sets sorting order. enum: ["desc","asc"]; default: "desc"
query.limit number Optional The number limits the objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit. default: 100; minimum: 1; maximum: 1000
query.cursor string Optional The cursor is an opaque token used to paginate through large sets of records. It indicates the position from which to continue when requesting the next set of records. A valid cursor value can be obtained from the cursor object in the result_info structure of a previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a67e14daa5f8dceeb91fe5449ba496ef"
  },
  "query": {
    "since": "2024-10-30",
    "before": "2024-10-31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account audit log product categories (Version 2) — cloudflare.audit-logs-v2-list-account-product-categories

Lists the available audit log product categories and the resource products each one expands to. Use these values with the product_category filter on the account audit logs endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The unique id that identifies the account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a67e14daa5f8dceeb91fe5449ba496ef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get resource change history from an account audit log entry (Version 2) — cloudflare.audit-logs-v2-get-account-audit-log-history

Returns the chronological change history for the resource identified by the given audit log entry.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The unique ID that identifies the account.
path.id string Required The ID of the audit log to fetch resource history for. format: "uuid"
query object Required additionalProperties: false
query.action_time string Required RFC3339 timestamp of the source audit log entry's action time. Used to narrow the source-entry lookup window. Provide the action.time value from the audit log identified by id. format: "date-time"
query.since string Required Limits the returned results to logs newer than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.before string Required Limits the returned results to logs older than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.direction string Optional Sets sorting order. enum: ["desc","asc"]; default: "desc"
query.limit number Optional The number limits the objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit. default: 100; minimum: 1; maximum: 1000
query.cursor string Optional The cursor is an opaque token used to paginate through large sets of records. It indicates the position from which to continue when requesting the next set of records. A valid cursor value can be obtained from the cursor object in the result_info structure of a previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "a67e14daa5f8dceeb91fe5449ba496ef",
    "id": "f174be97-19b1-40d6-954d-70cd5fbd52db"
  },
  "query": {
    "action_time": "2024-10-30T15:00:00Z",
    "since": "2024-10-30",
    "before": "2024-10-31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete CMB config — cloudflare.delete-accounts-account_id-logs-control-cmb-config

Deletes CMB config.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logcontrol_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get CMB config — cloudflare.get-accounts-account_id-logs-control-cmb-config

Gets CMB config.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logcontrol_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update CMB config — cloudflare.post-accounts-account_id-logs-control-cmb-config

Updates CMB config.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/logcontrol_identifier"
body — Required $ref: "#/definitions/logcontrol_cmb_config"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all DNS Protection rules. — cloudflare.deletednsprotectionrulesforaccount

Delete all DNS Protection rules for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all DNS Protection rules. — cloudflare.listdnsprotectionrulesforaccount

List all DNS Protection rules for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
query object Optional additionalProperties: false
query.page integer Optional The page number for pagination. Defaults to 1.
query.per_page integer Optional The number of items per page. Must be between 10 and 1000. Defaults to 25.
query.order string Optional The field to order by. Defaults to 'prefix'.
query.direction string Optional The direction of ordering (ASC or DESC). Defaults to 'ASC'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create DNS Protection rule. — cloudflare.creatednsprotectionrule

Create a DNS Protection rule for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_NewDnsProtectionRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "scope": "example",
    "name": "example",
    "mode": "example",
    "profile_sensitivity": "example",
    "rate_sensitivity": "example",
    "burst_sensitivity": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete DNS Protection rule. — cloudflare.deletednsprotectionrule

Delete a DNS Protection rule specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the DNS Protection rule to delete. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DNS Protection rule. — cloudflare.getdnsprotectionrule

Get a DNS Protection rule specified by the given UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the DNS Protection rule. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update DNS Protection rule. — cloudflare.updatednsprotectionrule

Update a DNS Protection rule specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the DNS Protection rule to update. $ref: "#/definitions/advanced-ddos-protection_uuid"
body — Required $ref: "#/definitions/advanced-ddos-protection_DnsProtectionRuleUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all allowlist prefixes. — cloudflare.deleteallowlistprefixesforaccount

Delete all allowlist prefixes for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all allowlist prefixes. — cloudflare.listallowlistprefixesforaccount

List all allowlist prefixes for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
query object Optional additionalProperties: false
query.page integer Optional The page number for pagination. Defaults to 1.
query.per_page integer Optional The number of items per page. Must be between 10 and 1000. Defaults to 25.
query.order string Optional The field to order by. Defaults to 'prefix'.
query.direction string Optional The direction of ordering (ASC or DESC). Defaults to 'ASC'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create allowlist prefix. — cloudflare.createallowlistedprefix

Create an allowlist prefix for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_NewInfraPrefix"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "prefix": "example",
    "comment": "example",
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete allowlist prefix. — cloudflare.deleteallowlistprefix

Delete the allowlist prefix for an account given a UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.prefix_id — Required The UUID of the allowlist prefix to delete. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "prefix_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get allowlist prefix. — cloudflare.getallowlistprefix

Get an allowlist prefix specified by the given UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.prefix_id — Required The UUID of the allowlist prefix. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "prefix_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update allowlist prefix. — cloudflare.updateallowlistprefix

Update an allowlist prefix specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.prefix_id — Required The UUID of the allowlist prefix to update. $ref: "#/definitions/advanced-ddos-protection_uuid"
body — Required $ref: "#/definitions/advanced-ddos-protection_InfraPrefixUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "prefix_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all prefixes. — cloudflare.deleteprefixesforaccount

Delete all prefixes for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all prefixes. — cloudflare.listprefixesforaccount

List all prefixes for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
query object Optional additionalProperties: false
query.page integer Optional The page number for pagination. Defaults to 1.
query.per_page integer Optional The number of items per page. Must be between 10 and 1000. Defaults to 25.
query.order string Optional The field to order by. Defaults to 'prefix'.
query.direction string Optional The direction of ordering (ASC or DESC). Defaults to 'ASC'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create prefix. — cloudflare.createprefix

Create a prefix for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_NewPrefix"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "prefix": "192.0.2.0/24",
    "comment": "example",
    "excluded": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create multiple prefixes. — cloudflare.bulkcreateprefixes

Create multiple prefixes for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body array Required
body[] — Optional $ref: "#/definitions/advanced-ddos-protection_NewPrefix"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete prefix. — cloudflare.deleteprefix

Delete the prefix for an account given a UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.prefix_id — Required The UUID of the prefix to delete. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "prefix_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get prefix. — cloudflare.getprefix

Get a prefix specified by the given UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.prefix_id — Required The UUID of the prefix. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "prefix_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update prefix. — cloudflare.updateprefix

Update a prefix specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.prefix_id — Required The UUID of the prefix to update. $ref: "#/definitions/advanced-ddos-protection_uuid"
body — Required $ref: "#/definitions/advanced-ddos-protection_PrefixUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "prefix_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all SYN Protection filters. — cloudflare.deletesynprotectionfiltersforaccount

Delete all SYN Protection filters for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all SYN Protection filters. — cloudflare.listsynprotectionfiltersforaccount

List all SYN Protection filters for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
query object Optional additionalProperties: false
query.mode string Optional The mode of the filters to get. Optional. Valid values: 'enabled', 'disabled', 'monitoring'.
query.page integer Optional The page number for pagination. Defaults to 1.
query.per_page integer Optional The number of items per page. Must be between 10 and 1000. Defaults to 25.
query.order string Optional The field to order by. Defaults to 'prefix'.
query.direction string Optional The direction of ordering (ASC or DESC). Defaults to 'ASC'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a SYN Protection filter. — cloudflare.createsynprotectionfilter

Create a SYN Protection filter for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_NewExpressionFilter"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "expression": "ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }",
    "mode": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete SYN Protection filter. — cloudflare.deletesynprotectionfilter

Delete a SYN Protection filter specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.filter_id — Required The UUID of the filter to delete. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "filter_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SYN Protection filter. — cloudflare.getsynprotectionfilter

Get a SYN Protection filter specified by the given UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.filter_id — Required The UUID of the filter to retrieve. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "filter_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update SYN Protection filter. — cloudflare.updatesynprotectionfilter

Update a SYN Protection filter specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.filter_id — Required The UUID of the filter to update. $ref: "#/definitions/advanced-ddos-protection_uuid"
body — Required $ref: "#/definitions/advanced-ddos-protection_ExpressionFilterUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "filter_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all SYN Protection rules. — cloudflare.deletesynprotectionrulesforaccount

Delete all SYN Protection rules for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all SYN Protection rules. — cloudflare.listsynprotectionrulesforaccount

List all SYN Protection rules for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
query object Optional additionalProperties: false
query.page integer Optional The page number for pagination. Defaults to 1.
query.per_page integer Optional The number of items per page. Must be between 10 and 1000. Defaults to 25.
query.order string Optional The field to order by. Defaults to 'prefix'.
query.direction string Optional The direction of ordering (ASC or DESC). Defaults to 'ASC'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create SYN Protection rule. — cloudflare.createsynprotectionrule

Create a SYN Protection rule for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_NewSynProtectionRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "scope": "example",
    "name": "example",
    "mode": "example",
    "rate_sensitivity": "example",
    "burst_sensitivity": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete SYN Protection rule. — cloudflare.deletesynprotectionrule

Delete a SYN Protection rule specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the SYN Protection rule to delete. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SYN Protection rule. — cloudflare.getsynprotectionrule

Get a SYN Protection rule specified by the given UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the SYN Protection rule. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update SYN Protection rule. — cloudflare.updatesynprotectionrule

Update a SYN Protection rule specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the SYN Protection rule to update. $ref: "#/definitions/advanced-ddos-protection_uuid"
body — Required $ref: "#/definitions/advanced-ddos-protection_SynProtectionRuleUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all TCP Flow Protection filters. — cloudflare.deletetcpflowprotectionfiltersforaccount

Delete all TCP Flow Protection filters for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all TCP Flow Protection filters. — cloudflare.listtcpflowprotectionfiltersforaccount

List all TCP Flow Protection filters for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
query object Optional additionalProperties: false
query.mode string Optional The mode of the filters to get. Optional. Valid values: 'enabled', 'disabled', 'monitoring'.
query.page integer Optional The page number for pagination. Defaults to 1.
query.per_page integer Optional The number of items per page. Must be between 10 and 1000. Defaults to 25.
query.order string Optional The field to order by. Defaults to 'prefix'.
query.direction string Optional The direction of ordering (ASC or DESC). Defaults to 'ASC'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a TCP Flow Protection filter. — cloudflare.createtcpflowprotectionfilter

Create a TCP Flow Protection filter for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_NewExpressionFilter"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "expression": "ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }",
    "mode": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete TCP Flow Protection filter. — cloudflare.deletetcpflowprotectionfilter

Delete a TCP Flow Protection filter specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.filter_id — Required The UUID of the filter to delete. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "filter_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TCP Flow Protection filter. — cloudflare.gettcpflowprotectionfilter

Get a TCP Flow Protection filter specified by the given UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.filter_id — Required The UUID of the filter to retrieve. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "filter_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update TCP Flow Protection filter. — cloudflare.updatetcpflowprotectionfilter

Update a TCP Flow Protection filter specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.filter_id — Required The UUID of the filter to update. $ref: "#/definitions/advanced-ddos-protection_uuid"
body — Required $ref: "#/definitions/advanced-ddos-protection_ExpressionFilterUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "filter_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all TCP Flow Protection rules. — cloudflare.deletetcpflowprotectionrulesforaccount

Delete all TCP Flow Protection rules for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all TCP Flow Protection rules. — cloudflare.listtcpflowprotectionrulesforaccount

List all TCP Flow Protection rules for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
query object Optional additionalProperties: false
query.page integer Optional The page number for pagination. Defaults to 1.
query.per_page integer Optional The number of items per page. Must be between 10 and 1000. Defaults to 25.
query.order string Optional The field to order by. Defaults to 'prefix'.
query.direction string Optional The direction of ordering (ASC or DESC). Defaults to 'ASC'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create TCP Flow Protection rule. — cloudflare.createtcpflowprotectionrule

Create a TCP Flow Protection rule for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_NewTcpFlowProtectionRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "scope": "example",
    "name": "example",
    "mode": "example",
    "rate_sensitivity": "example",
    "burst_sensitivity": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete TCP Flow Protection rule. — cloudflare.deletetcpflowprotectionrule

Delete a TCP Flow Protection rule specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the TCP Flow Protection rule to delete. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TCP Flow Protection rule. — cloudflare.gettcpflowprotectionrule

Get a TCP Flow Protection rule specified by the given UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the TCP Flow Protection rule. $ref: "#/definitions/advanced-ddos-protection_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update TCP Flow Protection rule. — cloudflare.updatetcpflowprotectionrule

Update a TCP Flow Protection rule specified by the given UUID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The ID of the account. $ref: "#/definitions/advanced-ddos-protection_identifier"
path.rule_id — Required The UUID of the TCP Flow Protection rule to update. $ref: "#/definitions/advanced-ddos-protection_uuid"
body — Required $ref: "#/definitions/advanced-ddos-protection_TcpFlowProtectionRuleUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get protection status. — cloudflare.getprotectionstatus

Get the protection status of the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The account ID. $ref: "#/definitions/advanced-ddos-protection_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update protection status. — cloudflare.updateprotectionstatus

Update the protection status of the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required The account ID. $ref: "#/definitions/advanced-ddos-protection_identifier"
body — Required $ref: "#/definitions/advanced-ddos-protection_UpdateProtectionStatus"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Apps — cloudflare.magic-account-apps-list-apps

Lists Apps associated with an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new App — cloudflare.magic-account-apps-add-app

Creates a new App for an account

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_app_add_single_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Cloudflare Dashboard",
    "type": "Development",
    "hostnames": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Account App — cloudflare.magic-account-apps-delete-app

Deletes specific Account App.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.account_app_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_app_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an App — cloudflare.magic-account-apps-patch-app

Updates an Account App

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.account_app_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_app_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_app_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Cloudflare Dashboard"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an App — cloudflare.magic-account-apps-update-app

Updates an Account App

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.account_app_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_app_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_app_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Cloudflare Dashboard"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List BGP Filter Profiles — cloudflare.magic-bgp-list-filter-profiles

Lists all BGP filter profiles for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create BGP Filter Profile — cloudflare.magic-bgp-create-filter-profile

Creates a new BGP filter profile for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_create_bgp_filter_profile_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allowed On-Prem Imports",
    "match_action": "allow",
    "targets": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete BGP Filter Profile — cloudflare.magic-bgp-delete-filter-profile

Deletes a BGP filter profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.profile_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "profile_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get BGP Filter Profile — cloudflare.magic-bgp-get-filter-profile

Gets a specific BGP filter profile for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.profile_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "profile_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get BGP Settings — cloudflare.magic-bgp-get-settings

Gets the BGP settings for an account, including the default ASN and redistribution configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update BGP Settings — cloudflare.magic-bgp-update-settings

Modifies the BGP settings for an account, including the default ASN and redistribution configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_update_bgp_settings_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List CF1 Sites — cloudflare.magic-cf1-sites-list-cf1-sites

Lists CF1 Sites associated with an account. A CF1 Site represents a physical customer network location with optional geographic coordinates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create CF1 Sites — cloudflare.magic-cf1-sites-create-cf1-sites

Creates new CF1 Sites for an account. Each site must have a unique name within the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body array Required minItems: 1
body[] — Optional $ref: "#/definitions/magic_cf1_site"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": [
    {
      "name": "Pad 34"
    }
  ]
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete CF1 Site — cloudflare.magic-cf1-sites-delete-cf1-site

Deletes a specific CF1 Site for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.cf1_site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "cf1_site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get CF1 Site — cloudflare.magic-cf1-sites-get-cf1-site

Gets a specific CF1 Site for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.cf1_site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "cf1_site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update CF1 Site — cloudflare.magic-cf1-sites-update-cf1-site

Partially updates a specific CF1 Site for an account. Only the fields included in the request body are modified; omitted fields retain their existing values.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.cf1_site_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_cf1_site_update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "cf1_site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List CF1 Site Ramps — cloudflare.magic-cf1-sites-list-cf1-site-ramps

Lists ramps (network connections) associated with a CF1 Site. Ramps represent GRE tunnels, IPsec tunnels, interconnects, or MCONN links.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.cf1_site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "cf1_site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create CF1 Site Ramps — cloudflare.magic-cf1-sites-create-cf1-site-ramps

Creates ramps (network connections) for a CF1 Site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.cf1_site_id — Required $ref: "#/definitions/magic_identifier"
body array Required minItems: 1
body[] — Optional $ref: "#/definitions/magic_cf1_site_ramp_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "cf1_site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": [
    {
      "source_ramp_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "type": "gre"
    }
  ]
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete CF1 Site Ramp — cloudflare.magic-cf1-sites-delete-cf1-site-ramp

Deletes a specific ramp from a CF1 Site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.cf1_site_id — Required $ref: "#/definitions/magic_identifier"
path.ramp_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "cf1_site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ramp_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get CF1 Site Ramp — cloudflare.magic-cf1-sites-get-cf1-site-ramp

Gets a specific ramp for a CF1 Site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.cf1_site_id — Required $ref: "#/definitions/magic_identifier"
path.ramp_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "cf1_site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ramp_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List interconnects — cloudflare.magic-interconnects-list-interconnects

Lists interconnects associated with an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update multiple interconnects — cloudflare.magic-interconnects-update-multiple-interconnects

Updates multiple interconnects associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body object Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List interconnect Details — cloudflare.magic-interconnects-list-interconnect-details

Lists details for a specific interconnect.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cf_interconnect_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cf_interconnect_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update interconnect — cloudflare.magic-interconnects-update-interconnect

Updates a specific interconnect associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cf_interconnect_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body — Required $ref: "#/definitions/magic_interconnect_tunnel_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cf_interconnect_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Connectors — cloudflare.mconn-connectors-list

Lists Magic WAN Connectors.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn_account_id"
query object Optional additionalProperties: false
query.device_type string Optional Filter connectors by device type. enum: ["MANAGED","LICENSED"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Connector — cloudflare.mconn-connectors-delete

Deletes a Magic WAN Connector.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn_account_id"
path.connector_id — Required $ref: "#/definitions/mconn_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Connector — cloudflare.mconn-connectors-get

Gets a Magic WAN Connector.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn_account_id"
path.connector_id — Required $ref: "#/definitions/mconn_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Connector — cloudflare.mconn-connectors-edit

Edits properties of a Magic WAN Connector. May be used to re-provision a license key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn_account_id"
path.connector_id — Required $ref: "#/definitions/mconn_uuid"
body — Required $ref: "#/definitions/mconn_customer_connectors_edit_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Connector — cloudflare.mconn-connectors-update

Updates properties of a Magic WAN Connector. May be used to re-provision a license key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn_account_id"
path.connector_id — Required $ref: "#/definitions/mconn_uuid"
body — Required $ref: "#/definitions/mconn_customer_connectors_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Interrupts — cloudflare.mconn-connector-interrupts-list

Lists interrupts for a Magic WAN Connector.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn_account_id"
path.connector_id — Required $ref: "#/definitions/mconn_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Events — cloudflare.mconn-connector-telemetry-events-list

Lists Magic WAN Connector Telemetry Events

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn-telemetry_account_id"
path.connector_id string Required
query object Required additionalProperties: false
query.from number Required
query.to number Required
query.limit number Optional
query.cursor string Optional
query.k string Optional Filter by event kind

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  },
  "query": {
    "from": 1,
    "to": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get latest Events — cloudflare.mconn-connector-telemetry-events-latest-get

Gets latest Magic WAN Connector Telemetry Events

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn-telemetry_account_id"
path.connector_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Event — cloudflare.mconn-connector-telemetry-events-get

Gets Magic WAN Connector Telemetry Event

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn-telemetry_account_id"
path.connector_id string Required
path.event_t number Required
path.event_n number Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example",
    "event_t": 1,
    "event_n": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Snapshots — cloudflare.mconn-connector-telemetry-snapshots-list

Lists Magic WAN Connector Telemetry Snapshots

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn-telemetry_account_id"
path.connector_id string Required
query object Required additionalProperties: false
query.from number Required
query.to number Required
query.limit number Optional
query.cursor string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  },
  "query": {
    "from": 1,
    "to": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get latest Snapshots — cloudflare.mconn-connector-telemetry-snapshots-latest-get

Gets latest Magic WAN Connector Telemetry Snapshots

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn-telemetry_account_id"
path.connector_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Snapshot — cloudflare.mconn-connector-telemetry-snapshots-get

Gets Magic WAN Connector Telemetry Snapshot

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mconn-telemetry_account_id"
path.connector_id string Required
path.snapshot_t number Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "example",
    "snapshot_t": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GRE tunnels — cloudflare.magic-gre-tunnels-list-gre-tunnels

Lists GRE tunnels associated with an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a GRE tunnel — cloudflare.magic-gre-tunnels-create-gre-tunnels

Creates a new GRE tunnel. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body — Required $ref: "#/definitions/magic_create_gre_tunnel_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "GRE_1",
    "customer_gre_endpoint": "203.0.113.1",
    "cloudflare_gre_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update multiple GRE tunnels — cloudflare.magic-gre-tunnels-update-multiple-gre-tunnels

Updates multiple GRE tunnels. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body object Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete GRE Tunnel — cloudflare.magic-gre-tunnels-delete-gre-tunnel

Disables and removes a specific static GRE tunnel. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gre_tunnel_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gre_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List GRE Tunnel Details — cloudflare.magic-gre-tunnels-list-gre-tunnel-details

Lists informtion for a specific GRE tunnel.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gre_tunnel_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gre_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update GRE Tunnel — cloudflare.magic-gre-tunnels-update-gre-tunnel

Updates a specific GRE tunnel. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.gre_tunnel_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body — Required $ref: "#/definitions/magic_gre_tunnel_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "gre_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "GRE_1",
    "customer_gre_endpoint": "203.0.113.1",
    "cloudflare_gre_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IPsec tunnels — cloudflare.magic-ipsec-tunnels-list-ipsec-tunnels

Lists IPsec tunnels associated with an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an IPsec tunnel — cloudflare.magic-ipsec-tunnels-create-ipsec-tunnels

Creates a new IPsec tunnel associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body — Required $ref: "#/definitions/magic_ipsec_tunnel_add_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "IPsec_1",
    "cloudflare_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update multiple IPsec tunnels — cloudflare.magic-ipsec-tunnels-update-multiple-ipsec-tunnels

Update multiple IPsec tunnels associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body object Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Pre-Shared Keys (PSK) for IPsec tunnels — cloudflare.magic-ipsec-tunnels-set-pre-shared-keys-for-ipsec-tunnels

Sets Pre-Shared Keys for multiple IPsec tunnels associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes. After PSKs are applied, they are immediately persisted to Cloudflare's edge and cannot be retrieved later. Store the PSKs in a safe place.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
query object Optional additionalProperties: false
query.validate_only boolean Optional If true, only run validation without persisting changes.
body — Required $ref: "#/definitions/magic_ipsec_tunnels_psk_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "psks": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete IPsec Tunnel — cloudflare.magic-ipsec-tunnels-delete-ipsec-tunnel

Disables and removes a specific static IPsec Tunnel associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ipsec_tunnel_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ipsec_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IPsec tunnel details — cloudflare.magic-ipsec-tunnels-list-ipsec-tunnel-details

Lists details for a specific IPsec tunnel.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ipsec_tunnel_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ipsec_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update IPsec Tunnel — cloudflare.magic-ipsec-tunnels-update-ipsec-tunnel

Updates a specific IPsec tunnel associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ipsec_tunnel_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.
body — Required $ref: "#/definitions/magic_ipsec_tunnel_add_single_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ipsec_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "IPsec_1",
    "cloudflare_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate Pre-Shared Key (PSK) for IPsec tunnels — cloudflare.magic-ipsec-tunnels-generate-pre-shared-key---psk--for-ipsec-tunnels

Generates a Pre-Shared Key for a specific IPsec tunnel used in the IKE session. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Store the PSK in a safe place.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ipsec_tunnel_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ipsec_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Redundancy Groups — cloudflare.magic-redundancy-groups-list-redundancy-groups

Lists redundancy groups associated with an account, including full member tunnel data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Redundancy Group — cloudflare.magic-redundancy-groups-create-redundancy-group

Creates a new redundancy group, optionally with tunnel members.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_create_redundancy_group_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "primary-group"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Redundancy Group — cloudflare.magic-redundancy-groups-delete-redundancy-group

Deletes a redundancy group. Member tunnels are not deleted — their redundancy_group_id is cleared.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.redundancy_group_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "redundancy_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Redundancy Group Details — cloudflare.magic-redundancy-groups-get-redundancy-group

Gets details for a specific redundancy group, including full member tunnel data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.redundancy_group_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "redundancy_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Redundancy Group — cloudflare.magic-redundancy-groups-update-redundancy-group

Replaces the name, description, and full set of members for an existing redundancy group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.redundancy_group_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_create_redundancy_group_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "redundancy_group_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "primary-group"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Many Routes — cloudflare.magic-static-routes-delete-many-routes

Delete multiple Magic static routes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_route_delete_many_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "routes": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Routes — cloudflare.magic-static-routes-list-routes

List all Magic static routes.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Route — cloudflare.magic-static-routes-create-routes

Creates a new Magic static route. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_create_route_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "prefix": "192.0.2.0/24",
    "nexthop": "203.0.113.1",
    "priority": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Many Routes — cloudflare.magic-static-routes-update-many-routes

Update multiple Magic static routes. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_route_update_many_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "routes": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Route — cloudflare.magic-static-routes-delete-route

Disable and remove a specific Magic static route.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Route Details — cloudflare.magic-static-routes-route-details

Get a specific Magic static route.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Route — cloudflare.magic-static-routes-update-route

Update a specific Magic static route. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_route_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "prefix": "192.0.2.0/24",
    "nexthop": "203.0.113.1",
    "priority": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Sites — cloudflare.magic-sites-list-sites

Lists Sites associated with an account. Use connectorid query param to return sites where connectorid matches either site.ConnectorID or site.SecondaryConnectorID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
query object Optional additionalProperties: false
query.connectorid — Optional $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Site — cloudflare.magic-sites-create-site

Creates a new Site

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_sites_add_single_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "site_1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Site — cloudflare.magic-sites-delete-site

Remove a specific Site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Site Details — cloudflare.magic-sites-site-details

Get a specific Site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
headers object Optional additionalProperties: false
headers.x-magic-new-hc-target boolean Optional If true, the health check target in the response body will be presented using the new object format. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Site — cloudflare.magic-sites-patch-site

Patch a specific Site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_site_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Site — cloudflare.magic-sites-update-site

Update a specific Site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_site_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Site ACLs — cloudflare.magic-site-acls-list-acls

Lists Site ACLs associated with an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Site ACL — cloudflare.magic-site-acls-create-acl

Creates a new Site ACL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_acls_add_single_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "PIN Pad - Cash Register",
    "lan_1": {
      "lan_id": "example"
    },
    "lan_2": {
      "lan_id": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Site ACL — cloudflare.magic-site-acls-delete-acl

Remove a specific Site ACL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.acl_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "acl_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Site ACL Details — cloudflare.magic-site-acls-acl-details

Get a specific Site ACL.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.acl_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "acl_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Site ACL — cloudflare.magic-site-acls-patch-acl

Patch a specific Site ACL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.acl_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_acl_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "acl_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Site ACL — cloudflare.magic-site-acls-update-acl

Update a specific Site ACL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.acl_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_acl_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "acl_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List App Configs — cloudflare.magic-site-app-configs-list-app-configs

Lists App Configs associated with a site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete App Config — cloudflare.magic-site-app-configs-delete-app-config

Deletes specific App Config associated with a site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.app_config_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_config_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an App Config — cloudflare.magic-site-app-configs-patch-app-config

Updates an App Config for a site

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.app_config_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_app_config_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_config_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an App Config — cloudflare.magic-site-app-configs-update-app-config

Updates an App Config for a site

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.app_config_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_app_config_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_config_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Site LANs — cloudflare.magic-site-lans-list-lans

Lists Site LANs associated with an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Site LAN — cloudflare.magic-site-lans-create-lan

Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_lans_add_single_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Site LAN — cloudflare.magic-site-lans-delete-lan

Remove a specific Site LAN.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.lan_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "lan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Site LAN Details — cloudflare.magic-site-lans-lan-details

Get a specific Site LAN.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.lan_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "lan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Site LAN — cloudflare.magic-site-lans-patch-lan

Patch a specific Site LAN.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.lan_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_lan_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "lan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Site LAN — cloudflare.magic-site-lans-update-lan

Update a specific Site LAN.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.lan_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_lan_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "lan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete NetFlow Configuration — cloudflare.magic-site-netflow-config-delete-netflow-config

Remove NetFlow configuration for a site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

NetFlow Configuration Details — cloudflare.magic-site-netflow-config-details

Get NetFlow configuration for a site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update NetFlow Configuration — cloudflare.magic-site-netflow-config-patch-netflow-config

Updates NetFlow configuration for a site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_netflow_config_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create NetFlow Configuration — cloudflare.magic-site-netflow-config-create-netflow-config

Creates a NetFlow configuration for a site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_netflow_config_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update NetFlow Configuration — cloudflare.magic-site-netflow-config-update-netflow-config

Updates NetFlow configuration for a site (partial update).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_netflow_config_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Site WANs — cloudflare.magic-site-wans-list-wans

Lists Site WANs associated with an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Site WAN — cloudflare.magic-site-wans-create-wan

Creates a new Site WAN.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.site_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_wans_add_single_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "physport": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Site WAN — cloudflare.magic-site-wans-delete-wan

Remove a specific Site WAN.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.wan_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "wan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Site WAN Details — cloudflare.magic-site-wans-wan-details

Get a specific Site WAN.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.wan_id — Required $ref: "#/definitions/magic_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "wan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Site WAN — cloudflare.magic-site-wans-patch-wan

Patch a specific Site WAN.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.wan_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_wan_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "wan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Site WAN — cloudflare.magic-site-wans-update-wan

Update a specific Site WAN.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id — Required $ref: "#/definitions/magic_identifier"
path.account_id — Required $ref: "#/definitions/magic_identifier"
path.wan_id — Required $ref: "#/definitions/magic_identifier"
body — Required $ref: "#/definitions/magic_wan_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "wan_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List repositories — cloudflare.listaccountvulnerabilitydiscoveryrepositories

Lists repositories available for vulnerability discovery in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
query object Optional additionalProperties: false
query.limit integer Optional default: 50; minimum: 1; maximum: 100
query.cursor string Optional minLength: 1; maxLength: 1024; pattern: "^[A-Za-z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create repository — cloudflare.createaccountvulnerabilitydiscoveryrepository

Creates an upload repository or reserves an asynchronous deployed Worker import by name. Worker imports require Idempotency-Key. Push upload source to main or specify the branch to scan in the scan request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
headers object Optional additionalProperties: false
headers.Idempotency-Key string Optional Optional. Supply this header to safely retry a request. Required when worker_script_name is supplied. minLength: 1; maxLength: 128; pattern: "^[!-~]+$"
body — Required $ref: "#/definitions/managed-defense-vulnerability-discovery_CreateRepositoryRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get repository — cloudflare.getaccountvulnerabilitydiscoveryrepository

Gets repository metadata, source readiness, and customer scan history.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
path.repo_id string Required format: "uuid"
query object Optional additionalProperties: false
query.scan_limit integer Optional default: 50; minimum: 1; maximum: 100
query.scan_cursor string Optional minLength: 1; maxLength: 1024; pattern: "^[A-Za-z0-9_-]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "repo_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get reviewed vulnerability report — cloudflare.getaccountrepositoryvulnerabilitydiscoveryreport

Gets the repository projection of the active operator-reviewed scan report. scan_id is the customer scan's stable request ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
path.repo_id string Required format: "uuid"
path.scan_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "repo_id": "00000000-0000-4000-8000-000000000000",
    "scan_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create upload token — cloudflare.createaccountvulnerabilitydiscoveryrepositorytoken

Creates a one-hour write token for an existing upload repository. Worker-imported repositories are system-managed and cannot receive upload tokens.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
path.repo_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "repo_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List scans — cloudflare.listaccountvulnerabilitydiscoveryscans

Lists customer-requested scans across review and execution lifecycle states.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
query object Optional additionalProperties: false
query.limit integer Optional default: 50; minimum: 1; maximum: 100
query.cursor string Optional minLength: 1; maxLength: 1024; pattern: "^[A-Za-z0-9_-]+$"
query.status — Optional Repeat parameter or provide comma-separated values.
query.status string Optional oneOf[1]; enum: ["requested","accepted","running","completed","failed","rejected","cancelled"]
query.status array Optional oneOf[2]
query.status[] string Optional oneOf[2]; enum: ["requested","accepted","running","completed","failed","rejected","cancelled"]
query.repo string Optional format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create scan — cloudflare.createaccountvulnerabilitydiscoveryscan

Submits repository intent for operator review. This endpoint does not immediately start execution. Worker-imported repositories must be ready; explicit repository host scopes must be authorized and explicit branch selections must exist before the request is persisted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
headers object Optional additionalProperties: false
headers.Idempotency-Key string Optional Optional. Supply this header to safely retry a request. Required when worker_script_name is supplied. minLength: 1; maxLength: 128; pattern: "^[!-~]+$"
body — Required $ref: "#/definitions/managed-defense-vulnerability-discovery_CreateScan"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "repos": [
      {
        "name": "example"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get scan — cloudflare.getaccountvulnerabilitydiscoveryscan

Gets one customer-requested scan across its review and execution lifecycle.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
path.scan_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "scan_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get reviewed vulnerability report — cloudflare.getaccountvulnerabilitydiscoveryconsolidatedreport

Gets the active operator-reviewed scan report. Repository metadata records report readiness even when no publication is available.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required pattern: "^[a-f0-9]{32}$"
path.scan_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "scan_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account Media usage — cloudflare.usage-analytics-get-account-media-usage

Retrieve Media usage analytics for an account. This endpoint shares the same backend handler as the Stream usage endpoint and returns identical Stream metrics (streamMinutesViewed). The gateway rewrites this path to the shared usage handler.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Standard Cloudflare hex account identifier. The API gateway translates this to an internal numeric ID before forwarding to the backend service. $ref: "#/definitions/usage-analytics_identifier"
query object Optional additionalProperties: false
query.metrics string Optional Comma-separated list of metrics to include in the response. Available metrics depend on the endpoint. Billing usage supports: streamMinutesViewed, rateLimitingRequestsAllowed, loadBalancingQueries, argoAcceleratedBytes, workersRequests, workersKVReads, imageResizingRequests, spectrumBytesTransferred, mediaUniqueTransformations. Stream/media usage supports: streamMinutesViewed.
query.since string Optional Start of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to 6 hours before the current time. format: "date-time"
query.until string Optional End of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to the current time. format: "date-time"
query.time_delta string Optional Time unit to aggregate usage observations into. Data retention is approximately 18 months. The effective number of data points returned depends on the time range and granularity selected. For example, requesting hourly granularity over 18 months could produce up to ~13,000 data points; use the limit parameter to cap results and be aware that responses may be truncated. enum: ["hour","day","week","month","quarter","year"]; default: "hour"
query.limit integer Optional Maximum number of data points to return. The actual number of results depends on the interaction between the time range (since/until) and time_delta granularity. Results are truncated to this limit without error if the time range produces more data points than the limit allows. default: 100; minimum: 1; maximum: 10000
query.filters string Optional Filter expressions to apply to the query. Format: field==value. Multiple filters can be combined.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Members — cloudflare.account-members-list-members

List all members of an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.order string Optional Field to order results by. enum: ["user.first_name","user.last_name","user.email","status"]
query.status string Optional A member's status in the account. enum: ["accepted","pending","rejected"]
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.direction string Optional Direction to order results. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Member — cloudflare.account-members-add-member

Add a user to the list of members for this account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required
body — Required oneOf[1]; $ref: "#/definitions/iam_create-member-with-roles"
body — Required oneOf[2]; $ref: "#/definitions/iam_create-member-with-policies"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "email": "[email protected]",
    "roles": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Member — cloudflare.account-members-remove-member

Remove a member from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.member_id — Required $ref: "#/definitions/iam_membership_components-schemas-identifier"
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "member_id": "4536bcfad5faccb111b47003c79917fa",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Member Details — cloudflare.account-members-member-details

Get information about a specific member of an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.member_id — Required $ref: "#/definitions/iam_membership_components-schemas-identifier"
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "member_id": "4536bcfad5faccb111b47003c79917fa",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Member — cloudflare.account-members-update-member

Modify an account member.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.member_id — Required $ref: "#/definitions/iam_membership_components-schemas-identifier"
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required
body — Required oneOf[1]; $ref: "#/definitions/iam_update-member-with-roles"
body — Required oneOf[2]; $ref: "#/definitions/iam_update-member-with-policies"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "member_id": "4536bcfad5faccb111b47003c79917fa",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete account configuration — cloudflare.magic-network-monitoring-configuration-delete-account-configuration

Delete an existing network monitoring configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account configuration — cloudflare.magic-network-monitoring-configuration-list-account-configuration

Lists default sampling, router IPs and warp devices for account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update account configuration fields — cloudflare.magic-network-monitoring-configuration-update-account-conf-75bc5c098c

Update fields in an existing network monitoring configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"
body object Required
body.default_sampling — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_default_sampling"
body.name — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_name"
body.router_ips — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_router_ips"
body.warp_devices — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_warp_devices"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create account configuration — cloudflare.magic-network-monitoring-configuration-create-account-configuration

Create a new network monitoring configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"
body object Required
body.default_sampling — Required $ref: "#/definitions/magic-visibility-mnm_mnm_config_default_sampling"
body.name — Required $ref: "#/definitions/magic-visibility-mnm_mnm_config_name"
body.router_ips — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_router_ips"
body.warp_devices — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_warp_devices"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  },
  "body": {
    "name": "cloudflare user's account",
    "default_sampling": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an entire account configuration — cloudflare.magic-network-monitoring-configuration-update-an-entire-ac-313c46ca16

Update an existing network monitoring configuration, requires the entire configuration to be updated at once.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"
body object Required
body.default_sampling — Required $ref: "#/definitions/magic-visibility-mnm_mnm_config_default_sampling"
body.name — Required $ref: "#/definitions/magic-visibility-mnm_mnm_config_name"
body.router_ips — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_router_ips"
body.warp_devices — Optional $ref: "#/definitions/magic-visibility-mnm_mnm_config_warp_devices"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  },
  "body": {
    "name": "cloudflare user's account",
    "default_sampling": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List rules and account configuration — cloudflare.magic-network-monitoring-configuration-list-rules-and-acco-ed4cfee0df

Lists default sampling, router IPs, warp devices, and rules for account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List rules — cloudflare.magic-network-monitoring-rules-list-rules

Lists network monitoring rules for account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete rule — cloudflare.magic-network-monitoring-rules-delete-rule

Delete a network monitoring rule for account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/magic-visibility-mnm_rule_identifier"
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "2890e6fa406311ed9b5a23f70f6fb8cf",
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get rule — cloudflare.magic-network-monitoring-rules-get-rule

List a single network monitoring rule for account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/magic-visibility-mnm_rule_identifier"
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "2890e6fa406311ed9b5a23f70f6fb8cf",
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update advertisement for rule — cloudflare.magic-network-monitoring-rules-update-advertisement-for-rule

Update advertisement for rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/magic-visibility-mnm_rule_identifier"
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "2890e6fa406311ed9b5a23f70f6fb8cf",
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate authentication token for VPC flow logs export. — cloudflare.magic-network-monitoring-vpc-flows-generate-authentication-token

Generate authentication token for VPC flow logs export.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-mnm_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "6f91088a406011ed95aed352566e8d4c"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account monetization eligibility — cloudflare.monetization-get-account-eligibility

Returns the account's latest stored monetization eligibility result.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/monetization_account-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check account monetization eligibility — cloudflare.monetization-check-account-eligibility

Checks the account for Monetization Gateway eligibility and returns its pending, approved, or rejected decision.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/monetization_account-identifier"
body — Required $ref: "#/definitions/monetization_monetization-account-eligibility-check-input"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  },
  "body": {
    "acceptedTermsOfService": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List relays — cloudflare.moq-relays-list

Lists all MoQ relays for the account. Returns only metadata. Config, status, and tokens are omitted.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
query object Optional additionalProperties: false
query.created_before string Optional Cursor for pagination. Returns relays created strictly before this RFC 3339 timestamp (typically the created value of the first item on the current page, to fetch the previous page). format: "date-time"
query.created_after string Optional Cursor for pagination. Returns relays created strictly after this RFC 3339 timestamp (typically the created value of the last item on the current page, to fetch the next page). format: "date-time"
query.per_page integer Optional Maximum number of relays to return per page. Values above the maximum are clamped to it rather than rejected. default: 1000; minimum: 1; maximum: 1000
query.asc boolean Optional Sort order by created. When true, results are returned oldest-first (ascending); otherwise newest-first (descending, the default). default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a relay — cloudflare.moq-relays-create

Provisions a new MoQ relay instance. Auto-creates a publish+subscribe token and a subscribe-only token. Token values are included in the response (shown once). Config is always set to defaults (upstreams off) and cannot be supplied here — sending a non-empty config is rejected (21014); null or {} is accepted as absent. Use PUT to configure the relay after it exists.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
body object Required
body.name string Required Human-readable name for the relay. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Production Live Stream"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a relay — cloudflare.moq-relays-delete

Soft-deletes a MoQ relay. The relay ID goes in the URL path — DELETE /accounts/{account_id}/moq/relays/{relay_id} — not the request body; there is no collection-level delete endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
path.relay_id string Required Relay unique identifier (32 hex characters). pattern: "^[0-9a-f]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "relay_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a relay — cloudflare.moq-relays-get

Retrieves a single MoQ relay including config and status. Tokens are NOT included.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
path.relay_id string Required Relay unique identifier (32 hex characters). pattern: "^[0-9a-f]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "relay_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a relay — cloudflare.moq-relays-update

Updates a relay's name and/or configuration. The relay ID goes in the URL path — PUT /accounts/{account_id}/moq/relays/{relay_id} — not the request body; there is no collection-level update endpoint. This is also the only way to set a relay's config (config cannot be set at create time). Partial updates: omitted fields are preserved; config sub-objects replace as whole objects when present.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
path.relay_id string Required Relay unique identifier (32 hex characters). pattern: "^[0-9a-f]{32}$"
body object Required
body.config — Optional
body.config — Optional allOf[1]; $ref: "#/definitions/moq_relay_config"
body.name string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "relay_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tokens — cloudflare.moq-relays-tokens-list

Returns metadata for every token the relay accepts. Secrets are never returned, so a token that has been lost cannot be recovered here. There is no expiry filter: compare each token's expires to the current time to tell which ones have lapsed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
path.relay_id string Required Relay unique identifier (32 hex characters). pattern: "^[0-9a-f]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "relay_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a token — cloudflare.moq-relays-tokens-create

Mints a new relay-scoped token and adds it to the relay's accepted-auth registry. The token value (secret) is shown once in the response. A relay may hold up to 10 tokens; creating an 11th is rejected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
path.relay_id string Required Relay unique identifier (32 hex characters). pattern: "^[0-9a-f]{32}$"
body object Required
body.expires string Optional Optional expiry (RFC 3339). Defaults to 1 year from creation; rejected if more than 1 year in the future. format: "date-time"
body.label string Optional Optional, customer-set label.
body.operations array Required Non-empty subset of the V1 roles the token is allowed to perform. Signed into the token. minItems: 1
body.operations[] string Optional enum: ["publish","subscribe"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "relay_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890"
  },
  "body": {
    "operations": [
      "publish",
      "subscribe"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke a token — cloudflare.moq-relays-tokens-delete

Revokes a token by removing it from the set the relay accepts. Relays cache that set, so revocation takes effect within seconds rather than instantly, and connections already established with the token are not closed. Revoking an unknown token succeeds, so the call is idempotent.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account identifier. $ref: "#/definitions/moq_account_identifier"
path.relay_id string Required Relay unique identifier (32 hex characters). pattern: "^[0-9a-f]{32}$"
path.jti string Required Token identifier (jti — 32 hex characters). pattern: "^[0-9a-f]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "relay_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "jti": "f3a1b2c3d4e5f67890a1b2c3d4e5f678"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Move account to organization — cloudflare.accounts_moveaccounts

Move an account into a destination organization, either assigning a standalone account to an organization or moving it between organizations in the same hierarchy. Availability depends on the organization's capabilities.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The ID of the account to move.
body object Required
body.destination_organization_id string Required The ID of the organization to move the account into.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "destination_organization_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List mTLS certificates — cloudflare.m-tls-certificate-management-list-m-tls-certificates

Lists all mTLS certificates uploaded to your account, such as Bring Your Own CA (BYO-CA) for mTLS. To list certificates issued by the Cloudflare managed CA, use the List Client Certificates endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.type array Optional Filters results by certificate type. Multiple types can be comma-separated.
query.type[] string Optional enum: ["custom","gateway_managed","access_managed"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload mTLS certificate — cloudflare.m-tls-certificate-management-upload-m-tls-certificate

Upload a certificate that you want to use with mTLS-enabled Cloudflare services, such as Bring Your Own CA (BYO-CA) for mTLS. To create certificates issued by the Cloudflare managed CA, use the Create Client Certificate endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.ca — Required $ref: "#/definitions/tls-certificates-and-hostnames_ca"
body.certificates — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificates-2"
body.name — Optional $ref: "#/definitions/tls-certificates-and-hostnames_name-2"
body.private_key — Optional $ref: "#/definitions/tls-certificates-and-hostnames_private_key-4"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "certificates": "-----BEGIN CERTIFICATE-----\nMIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQEL\nBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNV\nBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIx\nNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgM\nDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4\nYW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwg\nJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kC\nM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZ\nCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9\nK3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1Mx\nuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcL\nypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7\nz2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQE\nAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7\nNDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ711\n1Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTi\ni7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG\n+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomo\nShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4\nJhqeoTewsxndhDDE\n-----END CERTIFICATE-----",
    "ca": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete mTLS certificate — cloudflare.m-tls-certificate-management-delete-m-tls-certificate

Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.mtls_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_mtls_certificate_identifier"
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "mtls_certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get mTLS certificate — cloudflare.m-tls-certificate-management-get-m-tls-certificate

Fetches a single mTLS certificate uploaded to your account. To get a certificate issued by the Cloudflare managed CA, use the Client Certificate Details endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.mtls_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_mtls_certificate_identifier"
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "mtls_certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List mTLS certificate associations — cloudflare.m-tls-certificate-management-list-m-tls-certificate-associations

Lists all active associations between the certificate and Cloudflare services.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.mtls_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_mtls_certificate_identifier"
path.account_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "mtls_certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List OAuth Clients — cloudflare.oauth-clients-list

List all OAuth clients for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete OAuth Client — cloudflare.oauth-clients-delete

Delete an OAuth client.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.oauth_client_id — Required $ref: "#/definitions/iam_oauth_client_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "oauth_client_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

OAuth Client Details — cloudflare.oauth-clients-get

Get details of a specific OAuth client.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.oauth_client_id — Required $ref: "#/definitions/iam_oauth_client_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "oauth_client_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update OAuth Client — cloudflare.oauth-clients-update

Update an existing OAuth client. Only include fields you want to update.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.oauth_client_id — Required $ref: "#/definitions/iam_oauth_client_identifier"
body — Required $ref: "#/definitions/iam_oauth_client_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "oauth_client_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Rotated OAuth Client Secret — cloudflare.oauth-clients-delete-rotated-secret

Removes the old client secret after a rotation, keeping only the new one. Use this after you have updated your client configuration to use the new secret. The has_rotated_secret field on the client indicates whether there is an old secret to delete.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.oauth_client_id — Required $ref: "#/definitions/iam_oauth_client_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "oauth_client_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate OAuth Client Secret — cloudflare.oauth-clients-rotate-secret

Creates a second client secret so you can update your client configuration before deleting the old one. The has_rotated_secret field on the client will be set to true.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.oauth_client_id — Required $ref: "#/definitions/iam_oauth_client_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "oauth_client_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get usage limit status — cloudflare.observability.usage_limit.get

Whether Workers Observability is keeping fewer of the account's events, usually because it passed its daily limit, and what that limit is. Daily limits reset at 00:00 UTC; paid accounts are brought back in stages over the following hours.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List applications — cloudflare.list_applications_v2

Returns a list of available applications with use cases and permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
query object Optional additionalProperties: false
query.environment string Optional Filter by supported environment (standard, fedramp).
query.page integer Optional A page number within the paginated result set.
query.page_size integer Optional Number of results to return per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get application details — cloudflare.get_application_v2

Returns full application details including auth methods, use cases, and permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.application_id string Required Application/vendor identifier. enum: ["ANTHROPIC","AWS","BITBUCKET","BOX","CONFLUENCE","DROPBOX","GITHUB","GOOGLE_CLOUD_PLATFORM","GOOGLE_WORKSPACE","JIRA","MICROSOFT_INTERNAL","OPENAI","SALESFORCE","SERVICENOW","SLACK","ZOOM"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "application_id": "ANTHROPIC"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get auth methods — cloudflare.get_application_auth_methods_v2

Returns available auth methods for the specified vendor, including credential schema, instructions, and example payloads. Use this to understand what credentials are required before calling POST /v2/integrations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.application_id string Required Application/vendor identifier. enum: ["ANTHROPIC","AWS","BITBUCKET","BOX","CONFLUENCE","DROPBOX","GITHUB","GOOGLE_CLOUD_PLATFORM","GOOGLE_WORKSPACE","JIRA","MICROSOFT_INTERNAL","OPENAI","SALESFORCE","SERVICENOW","SLACK","ZOOM"]
query object Optional additionalProperties: false
query.page integer Optional A page number within the paginated result set.
query.page_size integer Optional Number of results to return per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "application_id": "ANTHROPIC"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get application setup flows — cloudflare.get_application_setup_flows_v2

Returns all available setup flows for the application, one per auth method.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.application_id string Required Application/vendor identifier. enum: ["ANTHROPIC","AWS","BITBUCKET","BOX","CONFLUENCE","DROPBOX","GITHUB","GOOGLE_CLOUD_PLATFORM","GOOGLE_WORKSPACE","JIRA","MICROSOFT_INTERNAL","OPENAI","SALESFORCE","SERVICENOW","SLACK","ZOOM"]
query object Optional additionalProperties: false
query.auth_method string Optional Filter by auth method id. Get available ids from GET /v2/applications.
query.environment string Optional Filter by environment. enum: ["fedramp","standard"]
query.page integer Optional A page number within the paginated result set.
query.page_size integer Optional Number of results to return per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "application_id": "ANTHROPIC"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List integrations — cloudflare.list_integrations_v2

Returns a paginated list of integrations for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
query object Optional additionalProperties: false
query.application string Optional Filter by application/vendor (e.g., GOOGLE_WORKSPACE, MICROSOFT_INTERNAL).
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.dlp_enabled boolean Optional Filter by DLP enabled status (true/false).
query.order string Optional Field to order results by. enum: ["application","created","name","status"]
query.page integer Optional Page number within the paginated result set.
query.page_size integer Optional Number of results per page.
query.search string Optional Search integrations by name or application.
query.status string Optional Filter by integration status. enum: ["Healthy","Initializing","Offline","Unhealthy"]
query.use_cases string Optional Filter by enabled use cases (e.g., casb, ces). Matches integrations enrolled in any of the specified values. Can be specified multiple times.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create integration — cloudflare.create_integration_v2

Creates a new integration for the specified application. Integration creation with OAuth is not supported by API at the moment. For other auth methods, use GET /v2/applications/{application_id}/credential-guide to see the required credential structure and example payloads for each vendor.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
body — Required $ref: "#/definitions/one_IntegrationV2CreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "application": "ANTHROPIC",
    "credentials": {},
    "name": "example",
    "use_cases": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete integration — cloudflare.delete_integration_v2

Delete an integration by soft-deleting it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.id string Required Integration ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get integration details — cloudflare.get_integration_v2

Returns full integration details including use cases and permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.id string Required Integration ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update integration — cloudflare.update_integration_v2

Updates an integration's name, permissions, DLP profiles, use cases, or credentials.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.id string Required Integration ID.
body — Optional $ref: "#/definitions/one_PatchedUpdateIntegrationV2Request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pause integration — cloudflare.pause_integration_v2

Pauses an integration, stopping all crawlers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.id string Required Integration ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resume integration — cloudflare.resume_integration_v2

Resumes a paused integration, restarting crawlers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare account identifier.
path.id string Required Integration ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account organizations — cloudflare.accounts_listaccountorganizations

Retrieve a list of the organizations that "contain" this account or are managing it.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Cloudflare Pages projects — cloudflare.pages-project-get-projects

List the Cloudflare Pages projects in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/pages_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of results to return.
query.per_page integer Optional Number of results to return per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Cloudflare Pages project — cloudflare.pages-project-create-project

Create a Cloudflare Pages project for configuring and deploying a site or application.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/pages_identifier"
body object Required
body.build_config object Optional Configs for the project build process.
body.build_config.build_caching boolean Optional Enable build caching for the project.
body.build_config.build_command string Optional Command used to build project.
body.build_config.destination_dir string Optional Output directory of the build.
body.build_config.root_dir string Optional Directory to run the command.
body.build_config.web_analytics_tag string | null Optional The classifying tag for analytics.
body.build_config.web_analytics_token string | null Optional The auth token for analytics.
body.deployment_configs object Optional Configs for deployments in a project.
body.deployment_configs.preview — Optional Configs for preview deploys.
body.deployment_configs.preview — Optional allOf[1]; $ref: "#/definitions/pages_deployment_config_values_request"
body.deployment_configs.production — Optional Configs for production deploys.
body.deployment_configs.production — Optional allOf[1]; $ref: "#/definitions/pages_deployment_config_values_request"
body.name string Required Name for the Pages project. Must begin with a lowercase letter or digit and contain only lowercase letters, digits, and hyphens.
body.production_branch string Required Production branch of the project. Used to identify production deployments.
body.source object Optional Configs for the project source control.
body.source.config object Required
body.source.config.deployments_enabled boolean Optional Whether to enable automatic deployments when pushing to the source repository. When disabled, no deployments (production or preview) will be triggered automatically.
body.source.config.owner string Optional The owner of the repository.
body.source.config.owner_id string Optional The owner ID of the repository.
body.source.config.path_excludes array Optional A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (*) is supported.
body.source.config.path_excludes[] string Optional
body.source.config.path_includes array Optional A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (*) is supported.
body.source.config.path_includes[] string Optional
body.source.config.pr_comments_enabled boolean Optional Whether to enable PR comments.
body.source.config.preview_branch_excludes array Optional A list of branches that should not trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom.
body.source.config.preview_branch_excludes[] string Optional
body.source.config.preview_branch_includes array Optional A list of branches that should trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom.
body.source.config.preview_branch_includes[] string Optional
body.source.config.preview_deployment_setting string Optional Controls whether commits to preview branches trigger a preview deployment. enum: ["all","none","custom"]
body.source.config.production_branch string Optional The production branch of the repository.
body.source.config.production_deployments_enabled boolean Optional Whether to trigger a production deployment on commits to the production branch.
body.source.config.repo_id string Optional The ID of the repository.
body.source.config.repo_name string Optional The name of the repository.
body.source.type string Required The source control management provider. enum: ["github","gitlab"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "my-pages-app",
    "production_branch": "main"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Cloudflare Pages project — cloudflare.pages-project-delete-project

Permanently delete a Cloudflare Pages project and its deployments.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Cloudflare Pages project — cloudflare.pages-project-get-project

Retrieve the configuration and deployment settings for a Cloudflare Pages project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Pages deployments — cloudflare.pages-deployment-get-deployments

List the production or preview deployments for a Cloudflare Pages project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"
query object Optional additionalProperties: false
query.env string Optional Deployment environment to return. Valid values are production and preview. enum: ["production","preview"]
query.page integer Optional Page number of results to return.
query.per_page integer Optional Number of results to return per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Pages deployment — cloudflare.pages-deployment-delete-deployment

Remove a deployment from a Cloudflare Pages project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deployment_id — Required $ref: "#/definitions/pages_deployment_id"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"
query object Optional additionalProperties: false
query.force boolean Optional Allow deletion when a non-production deployment has an active alias.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deployment_id": "f64788e9-fccd-4d4a-a28a-cb84f88f6e12",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Pages deployment — cloudflare.pages-deployment-get-deployment-info

Retrieve the status and details of a Cloudflare Pages deployment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deployment_id — Required $ref: "#/definitions/pages_deployment_id"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deployment_id": "f64788e9-fccd-4d4a-a28a-cb84f88f6e12",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Pages deployment logs — cloudflare.pages-deployment-get-deployment-logs

Retrieve the build logs for a Cloudflare Pages deployment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deployment_id — Required $ref: "#/definitions/pages_deployment_id"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deployment_id": "f64788e9-fccd-4d4a-a28a-cb84f88f6e12",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retry a Pages deployment — cloudflare.pages-deployment-retry-deployment

Retry a previous Cloudflare Pages deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deployment_id — Required $ref: "#/definitions/pages_deployment_id"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deployment_id": "f64788e9-fccd-4d4a-a28a-cb84f88f6e12",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Roll back a Pages deployment — cloudflare.pages-deployment-rollback-deployment

Roll back production to a previous successful Cloudflare Pages deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deployment_id — Required $ref: "#/definitions/pages_deployment_id"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deployment_id": "f64788e9-fccd-4d4a-a28a-cb84f88f6e12",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create deployment tail — cloudflare.pages-deployment-create-tail

Start a tail that receives logs and exception data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deployment_id — Required $ref: "#/definitions/pages_deployment_id"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"
body object Required
body.filters array Optional Filters to apply to the tail session.
body.filters[] object Optional additionalProperties: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deployment_id": "f64788e9-fccd-4d4a-a28a-cb84f88f6e12",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "filters": [
      {
        "outcome": [
          "exception"
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete deployment tail — cloudflare.pages-deployment-delete-tail

Deletes a tail from a Pages deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tail_id — Required $ref: "#/definitions/pages_identifier"
path.deployment_id — Required $ref: "#/definitions/pages_deployment_id"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tail_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "deployment_id": "f64788e9-fccd-4d4a-a28a-cb84f88f6e12",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Pages custom domains — cloudflare.pages-domains-get-domains

List the custom domains associated with a Cloudflare Pages project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a Pages custom domain — cloudflare.pages-domains-add-domain

Attach a custom domain to a Cloudflare Pages project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"
body object Required
body.name — Required $ref: "#/definitions/pages_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Pages custom domain — cloudflare.pages-domains-delete-domain

Remove a custom domain from a Cloudflare Pages project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_name — Required $ref: "#/definitions/pages_domain_name"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_name": "example.com",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Pages custom domain — cloudflare.pages-domains-get-domain

Retrieve the configuration and validation status of a custom domain attached to a Cloudflare Pages project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_name — Required $ref: "#/definitions/pages_domain_name"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_name": "example.com",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retry custom domain validation — cloudflare.pages-domains-patch-domain

Retry validation for a custom domain attached to a Cloudflare Pages project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_name — Required $ref: "#/definitions/pages_domain_name"
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_name": "example.com",
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge the Pages build cache — cloudflare.pages-purge-build-cache

Remove cached build artifacts so subsequent builds run without the project's existing build cache.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disconnect a Git repository — cloudflare.pages-project-disconnect-project-source

Disconnect the Git repository from a Cloudflare Pages project to stop Git-based deployments.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Connect a Git repository — cloudflare.pages-project-connect-project-source

Connect a GitHub or GitLab repository to a Cloudflare Pages project to enable Git-based deployments.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"
body — Required $ref: "#/definitions/pages_source_connect_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "github",
    "config": {
      "deployments_enabled": false,
      "owner": "my-org",
      "owner_id": "12345678",
      "path_excludes": [],
      "path_includes": [],
      "pr_comments_enabled": false,
      "preview_branch_excludes": [],
      "preview_branch_includes": [],
      "preview_deployment_setting": "all",
      "production_branch": "main",
      "production_deployments_enabled": false,
      "repo_id": "12345678",
      "repo_name": "my-repo"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get upload token — cloudflare.pages-project-get-upload-token

Get a short-lived JWT for Pages Direct Upload asset operations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_name — Required $ref: "#/definitions/pages_project_name"
path.account_id — Required $ref: "#/definitions/pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_name": "this-is-my-project-01",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pay Invoice — cloudflare.account-billing-pay-invoice

Pays an outstanding invoice for an account. Returns a Stripe client secret when Strong Customer Authentication (SCA) is required to complete the payment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body object Required
body.invoice_id string Optional The identifier of the invoice to pay.
body.payment_method_id string Optional The payment method to use. If omitted, the default payment method is used.
body.validate_payment_method boolean Optional Whether to validate the payment method before processing.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deletes the stripe config for a crawler — cloudflare.pay-per-crawl.crawlerdeletestripeconfig

Deletes the stripe config for a crawler.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Gets the stripe config for a crawler — cloudflare.pay-per-crawl.crawlergetstripeconfig

Gets the stripe config for a crawler.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates the stripe config for a crawler — cloudflare.pay-per-crawl.crawlercreatestripeconfig

Creates the stripe config for a crawler.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pay-per-crawl crawlers — cloudflare.pay-per-crawl.listcrawlers

Lists the crawlers known to pay-per-crawl.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deletes the stripe config for a publisher — cloudflare.pay-per-crawl.publisherdeletestripeconfig

Deletes the stripe config for a publisher.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Gets the stripe config for a publisher — cloudflare.pay-per-crawl.publishergetstripeconfig

Gets the stripe config for a publisher.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates the stripe config for a publisher — cloudflare.pay-per-crawl.publishercreatestripeconfig

Creates the stripe config for a publisher.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-crawl terms — cloudflare.pay-per-crawl.getterms

Gets the pay-per-crawl terms and conditions contract.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-crawl terms signature status — cloudflare.pay-per-crawl.gettermssignature

Gets the account's pay-per-crawl terms signature status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
query object Optional additionalProperties: false
query.remote boolean Optional Refresh the signature status from Ironclad.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Record pay-per-crawl terms activity — cloudflare.pay-per-crawl.sendtermssignatureevent

Records that an account displayed or agreed to the pay-per-crawl terms.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
query object Required additionalProperties: false
query.event_type string Required The terms activity to record. enum: ["agreed","displayed"]
query.vid string Required Ironclad contract version ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "event_type": "agreed",
    "vid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set can_be_enabled setting on zones — cloudflare.pay-per-crawl.setzonescanbeenabled

Allows an account admin to set the can_be_enabled setting on a list of zones. An omitted can_be_enabled value leaves that zone unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
body — Required $ref: "#/definitions/pay-per-crawl_ZonesCanBeEnabledUpdatePayload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "zones": [
      {
        "id": "example"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Gets the can_be_enabled zone setting — cloudflare.pay-per-crawl.queryzonescanbeenabled

Provided a list of pay-per-crawl configured zones this method will return whether they can enable PPC or not.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
body — Required $ref: "#/definitions/pay-per-crawl_ZonesCanBeEnabledQueryPayload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List enabled Pay Per Use domains — cloudflare.pay-per-use.listenableddomains

Returns publisher domains associated with the requesting Pay Per Use operator through an accepted price agreement. License expiration is the earlier non-null boundary from the price agreement and publisher zone lifecycles. A future expiration remains active and is exposed to the operator. After expiration, the license remains listed as expired for one calendar month before it is omitted; an active agreement for the same domain takes precedence. The requesting account must be an active Pay Per Use operator.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier for the participant
query object Optional additionalProperties: false
query.cursor string Optional Opaque, account-bound cursor returned by the previous page. Cursors expire after one hour; restart pagination without a cursor after receiving a 400 response for an expired cursor.
query.per_page integer Optional Maximum number of domains to return default: 100; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-use operator configuration — cloudflare.pay-per-crawl.getppuoperatorconfiguration

Gets the pay-per-use operator configuration for an account, including its read-only non-billable classification timestamp.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set pay-per-use operator configuration — cloudflare.pay-per-crawl.putppuoperatorconfiguration

Creates or updates the pay-per-use operator configuration for an account. Creating an enabled configuration or re-enabling a disabled billable operator requires completed Stripe onboarding, while non-billable operators do not; an already-enabled operator is not affected by later Stripe status changes. A Cloudflare-verified operator's name and default price cannot be changed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
body — Required $ref: "#/definitions/pay-per-crawl_PPUOperatorConfiguration"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example",
    "enabled": false,
    "default_price_usd_microcents": 100000
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pay-per-use price proposals — cloudflare.pay-per-crawl.listppuproposals

Lists a paginated set of outstanding pay-per-use publisher price proposals for an operator. Listing remains available while the operator is disabled or its name is unverified so proposals can be rejected.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
query object Optional additionalProperties: false
query.page integer Optional Page number. default: 1; minimum: 1
query.per_page integer Optional Results per page. default: 100; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Decide a pay-per-use price proposal — cloudflare.pay-per-crawl.postppuproposaldecision

Accepts or rejects the pending pay-per-use price proposal identified by price_id in the request body. Acceptance requires an enabled operator with a verified name, an enabled publisher zone, and matching billing classifications; rejection remains available for cleanup.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
body — Required $ref: "#/definitions/pay-per-crawl_PPUOperatorProposalActionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "action": "accept",
    "price_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-use usage statistics — cloudflare.pay-per-crawl.getppuusagestats

Returns reported usage and the full gross value across all Pay Per Use zones in a publisher account over an explicit UTC range of at most 31 days. Usage from every domain and snapshotted price is summed by buyer. Ranges up to and including 7 days use hourly data points; longer ranges use daily data points. Because source data is aggregated hourly, both requested bounds are rounded down to the selected UTC interval and the resolved bounds are returned in the response. The resolved range must contain at least one complete interval. Empty periods are omitted. Buyers and their data points are paginated, while totals cover every buyer in the range. Values are raw usage counts and USD microcents; total_price_usd_microcents is the full value before the publisher revenue share.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
query object Required additionalProperties: false
query.since string Required Requested inclusive beginning of the statistics range as an RFC3339 timestamp. Rounded down to the selected UTC interval. format: "date-time"
query.until string Required Requested exclusive end of the statistics range as an RFC3339 timestamp. Rounded down to the selected UTC interval. The requested duration from since cannot exceed 31 days. format: "date-time"
query.page integer Optional Page number. default: 1; minimum: 1
query.per_page integer Optional Results per page. default: 100; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "since": "2026-01-01T00:00:00Z",
    "until": "2026-01-01T00:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set pay-per-use zone eligibility — cloudflare.pay-per-crawl.setppuzonescanbeenabled

Sets pay-per-use eligibility for a list of account zones. An omitted can_be_enabled value leaves that zone unchanged. Revoking eligibility disables the zone immediately while existing accepted licenses remain active until the start of the next UTC month.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required account id
body — Required $ref: "#/definitions/pay-per-crawl_PPUZonesCanBeEnabledPayload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "zones": [
      {
        "id": "example"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Payment Methods — cloudflare.account-billing-list-payment-methods

Lists all payment methods for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of items per page. default: 20; minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Payment Method — cloudflare.account-billing-create-payment-method

Creates a new payment method for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_payment_method"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Payment Method — cloudflare.account-billing-delete-payment-method

Deletes a payment method from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
path.payment_method_id — Required Payment method identifier. $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "payment_method_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Payment Method — cloudflare.account-billing-get-payment-method

Gets a specific payment method for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
path.payment_method_id — Required Payment method identifier. $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "payment_method_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Payment Method — cloudflare.account-billing-update-payment-method

Updates a payment method for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
path.payment_method_id — Required Payment method identifier. $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_payment_method"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "payment_method_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Default Payment Method — cloudflare.account-billing-set-default-payment-method

Sets a payment method as the default for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
path.payment_method_id — Required Payment method identifier. $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "payment_method_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List packet capture requests — cloudflare.magic-pcap-collection-list-packet-capture-requests

Lists all packet capture requests for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create PCAP request — cloudflare.magic-pcap-collection-create-pcap-request

Create new PCAP request for account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"
body — Required $ref: "#/definitions/magic-visibility-pcaps_pcaps_request_pcap"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "time_limit": 300,
    "packet_limit": 10000,
    "type": "simple",
    "system": "magic-transit"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List PCAPs Bucket Ownership — cloudflare.magic-pcap-collection-list-pca-ps-bucket-ownership

List all buckets configured for use with PCAPs API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add buckets for full packet captures — cloudflare.magic-pcap-collection-add-buckets-for-full-packet-captures

Adds an AWS or GCP bucket to use with full packet captures.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"
body — Required $ref: "#/definitions/magic-visibility-pcaps_pcaps_ownership_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://pcaps-bucket?region=us-east-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate buckets for full packet captures — cloudflare.magic-pcap-collection-validate-buckets-for-full-packet-captures

Validates buckets added to the packet captures API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"
body — Required $ref: "#/definitions/magic-visibility-pcaps_pcaps_ownership_validate_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://pcaps-bucket?region=us-east-1",
    "ownership_challenge": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete buckets for full packet captures — cloudflare.magic-pcap-collection-delete-buckets-for-full-packet-captures

Deletes buckets added to the packet captures API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ownership_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ownership_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get PCAP request — cloudflare.magic-pcap-collection-get-pcap-request

Get information for a PCAP request by id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pcap_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pcap_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop full PCAP — cloudflare.magic-pcap-collection-stop-full-pcap

Stop full PCAP.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pcap_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"
path.account_id — Required $ref: "#/definitions/magic-visibility-pcaps_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pcap_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Pipelines — cloudflare.getv4accountsbyaccount_idpipelinesv1pipelines

List/Filter Pipelines in Account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
query object Optional additionalProperties: false
query.page number Optional default: 1
query.per_page number Optional
query.name string Optional Filters pipelines by name (case-insensitive substring). minLength: 1; maxLength: 128

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Pipeline — cloudflare.postv4accountsbyaccount_idpipelinesv1pipelines

Create a new Pipeline.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
body object Optional
body.name string Required Specifies the name of the Pipeline. minLength: 1; maxLength: 128
body.sql string Required Specifies SQL for the Pipeline processing flow.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Pipeline — cloudflare.deletev4accountsbyaccount_idpipelinesv1pipelinesbypipeline_id

Delete Pipeline in Account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
path.pipeline_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-pipeline-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "pipeline_id": "043e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Pipeline Details — cloudflare.getv4accountsbyaccount_idpipelinesv1pipelinesbypipeline_id

Get Pipeline details.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
path.pipeline_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-pipeline-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "pipeline_id": "043e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Sinks — cloudflare.getv4accountsbyaccount_idpipelinesv1sinks

List/Filter Sinks in Account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
query object Optional additionalProperties: false
query.pipeline_id string Optional
query.name string Optional Filters sinks by name (case-insensitive substring). minLength: 1; maxLength: 128
query.order_by string Optional Sorts sinks by this field. Defaults to created_at. enum: ["name","created_at"]
query.direction string Optional Sort direction. enum: ["asc","desc"]; default: "asc"
query.page number Optional default: 1
query.per_page number Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Sink — cloudflare.postv4accountsbyaccount_idpipelinesv1sinks

Create a new Sink.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
body object Optional
body.config — Optional Defines the configuration of the R2 Sink.
body.config — Optional oneOf[1]; $ref: "#/definitions/cloudflare-pipelines_r2Table"
body.config — Optional oneOf[2]; $ref: "#/definitions/cloudflare-pipelines_r2_data_catalogTable"
body.format — Optional $ref: "#/definitions/cloudflare-pipelines_SinkFormat"
body.name string Required Defines the name of the Sink. minLength: 1; maxLength: 128
body.schema — Optional $ref: "#/definitions/cloudflare-pipelines_ConnectionSchema"
body.type string Required Specifies the type of sink. enum: ["r2","r2_data_catalog","basin_catalog"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Sink — cloudflare.deletev4accountsbyaccount_idpipelinesv1sinksbysink_id

Delete Sink in Account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
path.sink_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-sink-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "sink_id": "0223105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Sink Details — cloudflare.getv4accountsbyaccount_idpipelinesv1sinksbysink_id

Get Sink Details.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
path.sink_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-sink-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "sink_id": "0223105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Streams — cloudflare.getv4accountsbyaccount_idpipelinesv1streams

List/Filter Streams in Account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
query object Optional additionalProperties: false
query.pipeline_id — Optional $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-pipeline-id"
query.name string Optional Filters streams by name (case-insensitive substring). minLength: 1; maxLength: 128
query.order_by string Optional Sorts streams by this field. Defaults to created_at. enum: ["name","created_at"]
query.direction string Optional Sort direction. enum: ["asc","desc"]; default: "asc"
query.page number Optional default: 1
query.per_page number Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Stream — cloudflare.postv4accountsbyaccount_idpipelinesv1streams

Create a new Stream.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
body object Optional
body.format — Optional $ref: "#/definitions/cloudflare-pipelines_Format"
body.http object Optional default: {"authentication":false,"enabled":true}
body.http.authentication boolean Required Indicates that authentication is required for the HTTP endpoint.
body.http.cors object Optional Specifies the CORS options for the HTTP endpoint.
body.http.cors.origins array Optional maxItems: 5
body.http.cors.origins[] string Optional
body.http.enabled boolean Required Indicates that the HTTP endpoint is enabled.
body.name string Required Specifies the name of the Stream. minLength: 1; maxLength: 128
body.schema — Optional $ref: "#/definitions/cloudflare-pipelines_ConnectionSchema"
body.worker_binding object Optional default: {"enabled":true}
body.worker_binding.enabled boolean Required Indicates that the worker binding is enabled.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Stream — cloudflare.deletev4accountsbyaccount_idpipelinesv1streamsbystream_id

Delete Stream in Account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
path.stream_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-stream-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "stream_id": "033e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Stream Details — cloudflare.getv4accountsbyaccount_idpipelinesv1streamsbystream_id

Get Stream Details.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
path.stream_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-stream-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "stream_id": "033e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Stream — cloudflare.patchv4accountsbyaccount_idpipelinesv1streamsbystream_id

Update a Stream.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
path.stream_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-stream-id"
body object Optional
body.http object Optional
body.http.authentication boolean Required Indicates that authentication is required for the HTTP endpoint.
body.http.cors object Optional Specifies the CORS options for the HTTP endpoint.
body.http.cors.origins array Optional maxItems: 5
body.http.cors.origins[] string Optional
body.http.enabled boolean Required Indicates that the HTTP endpoint is enabled.
body.worker_binding object Optional
body.worker_binding.enabled boolean Required Indicates that the worker binding is enabled.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353",
    "stream_id": "033e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate SQL — cloudflare.postv4accountsbyaccount_idpipelinesv1validate_sql

Validates that the Pipelines SQL is correct.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/cloudflare-pipelines_workers-pipelines-account-id"
body object Optional
body.sql string Required Specifies SQL to validate.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "0123105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account profile — cloudflare.accounts_getaccountprofile

Retrieves the business profile (name, email, phone, address, and external metadata) associated with this account's customer record. Profiles can be shared across accounts and organizations. Only available to members of an organization that contains the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The ID of the account whose business profile to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update account profile — cloudflare.accounts_modifyaccountprofile

Partially updates the business profile (name, email, phone, address, and external metadata) associated with this account's parent organization customer record, creating the profile if it does not exist. Changes apply to every account and organization sharing that profile. Omitted, empty, or null fields are left unchanged. Each profile field is limited to 1,000 UTF-8 bytes. Only available to members of an organization that contains the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The ID of the account whose business profile to update.
body — Required $ref: "#/definitions/organizations-api_ModifyProfileRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Queues — cloudflare.queues-list

Returns the queues owned by an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Queue — cloudflare.queues-create

Creates a Queue in the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Optional
body.jurisdiction — Optional $ref: "#/definitions/mq_jurisdiction"
body.queue_name — Required $ref: "#/definitions/mq_queue-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Queue — cloudflare.queues-delete

Deletes a Queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Queue — cloudflare.queues-get

Returns details about a specific Queue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Queue — cloudflare.queues-update-partial

Updates part of a Queue's configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body — Optional $ref: "#/definitions/mq_queue"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Queue — cloudflare.queues-update

Replaces a Queue's configuration with the supplied configuration. This endpoint does not support partial updates.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body — Optional $ref: "#/definitions/mq_queue"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Queue Consumers — cloudflare.queues-list-consumers

Returns the consumers configured for a Queue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Queue Consumer — cloudflare.queues-create-consumer

Creates a consumer for a Queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body — Optional $ref: "#/definitions/mq_consumer-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Queue Consumer — cloudflare.queues-delete-consumer

Deletes a consumer from a Queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.consumer_id — Required $ref: "#/definitions/mq_identifier"
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Queue Consumer — cloudflare.queues-get-consumer

Returns a Queue consumer by identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.consumer_id — Required $ref: "#/definitions/mq_identifier"
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Queue Consumer — cloudflare.queues-update-consumer

Replaces a Queue consumer, or creates it if it does not exist.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.consumer_id — Required $ref: "#/definitions/mq_identifier"
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body — Required $ref: "#/definitions/mq_consumer-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "worker",
    "script_name": "my-consumer-worker"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Push Message — cloudflare.queues-push-message

Pushes a message to a Queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body — Optional $ref: "#/definitions/mq_queue-message"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Acknowledge + Retry Queue Messages — cloudflare.queues-ack-messages

Acknowledges successfully processed Queue messages and retries messages that were not processed successfully.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Optional
body.acks array Optional
body.acks[] object Optional
body.acks[].lease_id — Optional $ref: "#/definitions/mq_lease-id"
body.retries array Optional
body.retries[] object Optional
body.retries[].delay_seconds — Optional $ref: "#/definitions/mq_retry-delay"
body.retries[].lease_id — Optional $ref: "#/definitions/mq_lease-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Push Message Batch — cloudflare.queues-push-messages

Pushes a batch of messages to a Queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body — Optional $ref: "#/definitions/mq_queue-batch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Extend Message Leases — cloudflare.queues-extend-messages

Extends message leases without incrementing the messages' attempts counters. Each message receives a new lease identifier.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Optional
body.extend array Optional
body.extend[] object Optional
body.extend[].lease_id — Optional $ref: "#/definitions/mq_lease-id"
body.visibility_timeout_ms — Optional $ref: "#/definitions/mq_visibility-timeout"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Peek Queue Messages — cloudflare.queues-peek-messages

Peek messages from a Queue without leasing them. Each message includes a ref that can be passed to the purge endpoint, and remains available for subsequent peek or pull operations until it is purged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Optional
body.batch_size — Optional $ref: "#/definitions/mq_batch-size"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pull Queue Messages — cloudflare.queues-pull-messages

Pulls a batch of messages from a Queue for an HTTP pull consumer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Optional
body.batch_size — Optional $ref: "#/definitions/mq_batch-size"
body.visibility_timeout_ms — Optional $ref: "#/definitions/mq_visibility-timeout"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge Peeked Queue Messages — cloudflare.queues-purge-messages

Delete messages from a Queue by using refs returned by the peek endpoint. Purging messages does not count as delivery and does not affect metrics.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Required
body.refs array Required
body.refs[] object Optional
body.refs[].ref — Required $ref: "#/definitions/mq_ref"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "refs": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Queue Metrics — cloudflare.queues-get-metrics

Returns best-effort metrics for a Queue. Values may be approximate due to the distributed nature of Queues.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Queue Purge Status — cloudflare.queues-purge-get

Returns the status of a Queue purge operation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge Queue — cloudflare.queues-purge

Starts a purge that deletes all messages from a Queue.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.queue_id — Required $ref: "#/definitions/mq_identifier"
path.account_id — Required $ref: "#/definitions/mq_identifier"
body object Optional
body.delete_messages_permanently boolean Optional Confirms that all messages will be permanently deleted.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Buckets — cloudflare.r2-list-buckets

Lists a page of R2 buckets in the account and selected jurisdiction. Use the returned cursor to retrieve the next page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
query object Optional additionalProperties: false
query.name_contains string Optional Bucket names to filter by. Only buckets with this phrase in their name will be returned.
query.start_after string Optional Bucket name to start searching after. Buckets are ordered lexicographically.
query.per_page number Optional Maximum number of buckets to return in a single call. default: 20; minimum: 1; maximum: 1000
query.order string Optional Field to order buckets by. enum: ["name"]
query.direction string Optional Direction to order buckets. enum: ["asc","desc"]
query.cursor string Optional Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers.
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Bucket — cloudflare.r2-delete-bucket

Deletes an empty R2 bucket and its configuration. The bucket must have no objects, no in-progress multipart uploads, and no event notification rules; otherwise the request fails.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Bucket — cloudflare.r2-get-bucket

Gets properties of an existing R2 bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Bucket — cloudflare.r2-patch-bucket

Changes the default storage class for newly uploaded objects in an existing R2 bucket. Existing objects retain their storage class, and individual uploads can override the bucket default.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Required additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
headers.cf-r2-storage-class — Required
headers.cf-r2-storage-class — Required allOf[1]; $ref: "#/definitions/r2_storage_class"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  },
  "headers": {
    "cf-r2-storage-class": "Standard"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Bucket (by name) — cloudflare.r2-create-bucket-by-name

Creates a new R2 bucket using the name from the URL path. Similar to r2-create-bucket (POST), but the bucket name comes from the path and the optional storage class is supplied via the cf-r2-storage-class header. There is no request body. Unlike the POST variant, this endpoint does not accept a location hint — the bucket is placed in the R2 region for the caller's edge colo. Use the POST variant if you need to set a locationHint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
headers.cf-r2-storage-class — Optional
headers.cf-r2-storage-class — Optional allOf[1]; $ref: "#/definitions/r2_storage_class"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Bucket CORS Policy — cloudflare.r2-delete-bucket-cors-policy

Delete the CORS policy for a bucket.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Bucket CORS Policy — cloudflare.r2-get-bucket-cors-policy

Get the CORS policy for a bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Bucket CORS Policy — cloudflare.r2-put-bucket-cors-policy

Replaces the Cross-Origin Resource Sharing (CORS) rules for an R2 bucket. Rules specify which origins, methods, and headers are allowed for browser requests to objects in the bucket.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
body object Required
body.rules array Optional
body.rules[] — Optional $ref: "#/definitions/r2_cors-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Custom Domains of Bucket — cloudflare.r2-list-custom-domains

Gets a list of all custom domains registered with an existing R2 bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Attach Custom Domain To Bucket — cloudflare.r2-add-custom-domain

Register a new custom domain for an existing R2 bucket.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
body — Required $ref: "#/definitions/r2_add_custom_domain_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  },
  "body": {
    "domain": "prefix.example-domain.com",
    "enabled": true,
    "zoneId": "36ca64a6d92827b8a6b90be344bb1bfd"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Custom Domain From Bucket — cloudflare.r2-delete-custom-domain

Disconnects a custom domain from an R2 bucket and removes its configuration. Access through other enabled custom domains or the bucket's r2.dev domain is unaffected.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.domain — Required $ref: "#/definitions/r2_domain_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain": "example-domain/custom-domain.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Custom Domain Settings — cloudflare.r2-get-custom-domain-settings

Get the configuration for a custom domain on an existing R2 bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.domain — Required $ref: "#/definitions/r2_domain_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket",
    "domain": "example-domain/custom-domain.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Configure Custom Domain Settings — cloudflare.r2-edit-custom-domain-settings

Edit the configuration for a custom domain on an existing R2 bucket.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.domain — Required $ref: "#/definitions/r2_domain_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
body — Required $ref: "#/definitions/r2_edit_custom_domain_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket",
    "domain": "example-domain/custom-domain.com"
  },
  "body": {
    "enabled": true,
    "minTLS": "1.2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get r2.dev Domain of Bucket — cloudflare.r2-get-bucket-public-policy

Gets the R2 bucket's managed r2.dev domain and whether public access is enabled. The r2.dev domain is rate-limited and intended for development use.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update r2.dev Domain of Bucket — cloudflare.r2-put-bucket-public-policy

Enables or disables public access to the R2 bucket through its managed r2.dev domain. Custom domain access is unaffected. The r2.dev domain is rate-limited and intended for development use.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
body — Required $ref: "#/definitions/r2_edit_managed_domain_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Bucket Jobs — cloudflare.r2-list-bucket-jobs

Lists background jobs for an R2 bucket, including prefix-delete (and bucket-emptying) jobs and storage-class migration jobs. Jobs of every type are returned unless jobType is provided.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
query object Optional additionalProperties: false
query.jobType string Optional Restricts results to jobs of the specified type. enum: ["prefixDelete","storageClassMigration"]
query.status — Optional Restricts results to jobs with the specified status. jobType is required when this parameter is provided. $ref: "#/definitions/r2_r2_bucket_job_status"
query.maxKeys integer Optional Maximum number of jobs to return. minimum: 0; maximum: 1000
query.continuationToken string Optional Pagination token received as nextContinuationToken in the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Bucket Job — cloudflare.r2-create-bucket-job

Creates a background job for an R2 bucket. The jobType field selects the job:

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
headers.cf-r2-data-catalog-check string Optional For prefix-delete jobs, set this header to reject the request when R2 Data Catalog is enabled for the bucket.
body — Required
body — Required oneOf[1]; $ref: "#/definitions/r2_create_prefix_delete_job_request"
body — Required oneOf[2]; $ref: "#/definitions/r2_create_storage_class_migration_job_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  },
  "body": {
    "jobType": "prefixDelete",
    "prefix": "logs/2026/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Bucket Job — cloudflare.r2-get-bucket-job

Gets the current status of a background job of any type for an R2 bucket. Poll this endpoint with the job identifier returned by Create Bucket Job until the status is COMPLETED, FAILED, or CANCELLED.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.job_id string Required Identifier returned when the background job was submitted.
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Object Lifecycle Rules — cloudflare.r2-get-bucket-lifecycle-configuration

Get object lifecycle rules for a bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Object Lifecycle Rules — cloudflare.r2-put-bucket-lifecycle-configuration

Replaces the object lifecycle rules for an R2 bucket. Rules match object-key prefixes and can expire objects, abort incomplete multipart uploads, or transition objects to Infrequent Access storage.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
body object Required
body.rules array Optional
body.rules[] — Optional $ref: "#/definitions/r2_lifecycle-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Local Uploads Configuration — cloudflare.r2-get-bucket-local-uploads-configuration

Gets the Local Uploads configuration for an R2 bucket. When enabled, object data is written near the client before being asynchronously copied to the bucket's primary region. Local Uploads is only supported in the default jurisdiction.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Local Uploads Configuration — cloudflare.r2-put-bucket-local-uploads-configuration

Enables or disables Local Uploads for an R2 bucket in the default jurisdiction. When enabled, object data is written near the client before being asynchronously copied to the bucket's primary region. Disabling Local Uploads allows existing replication to finish.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
body object Required
body.enabled boolean Required Whether to enable local uploads for this bucket.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Bucket Lock Rules — cloudflare.r2-delete-bucket-lock-configuration

Delete all lock rules for a bucket.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Bucket Lock Rules — cloudflare.r2-get-bucket-lock-configuration

Get lock rules for a bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Bucket Lock Rules — cloudflare.r2-put-bucket-lock-configuration

Replaces the lock rules for an R2 bucket. Enabled rules prevent matching objects from being overwritten or deleted for a duration, until a date, or indefinitely. Rules apply to existing and newly uploaded objects.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
body object Required
body.rules array Optional
body.rules[] — Optional $ref: "#/definitions/r2_bucket-lock-rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Objects — cloudflare.r2-delete-objects

Deletes the listed objects from an R2 bucket. Provide a JSON array of 1 to 1000 object keys in the request body.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
headers.cf-r2-data-catalog-check string Optional Set this header to reject the operation when R2 Data Catalog is enabled for the bucket.
query object Optional additionalProperties: false
query.prefix string Optional Deprecated. Create a prefixDelete job with the Create Bucket Job endpoint instead. When present, the request body is ignored and a prefix-delete job is created for this prefix, exactly as Create Bucket Job does; an empty value empties the bucket. The response is the job descriptor, with a Deprecation header and a deprecation message in messages.
body array Optional minItems: 1; maxItems: 1000
body[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Objects — cloudflare.r2-list-objects

Lists objects in an R2 bucket. Returns object metadata including key, size, etag, last modified date, HTTP metadata, and custom metadata.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"
query object Optional additionalProperties: false
query.per_page integer Optional Maximum number of objects to return per page. default: 20; minimum: 1; maximum: 1000
query.prefix string Optional Restricts results to only those objects whose keys begin with the specified prefix.
query.delimiter string Optional A single character used to group keys. All keys that contain the delimiter between the prefix and the first occurrence of the delimiter after the prefix are grouped under a single result element.
query.cursor string Optional Pagination cursor received from a previous List Objects call. Used to retrieve the next page of results.
query.start_after string Optional Returns objects with keys that come after the specified key in lexicographic order.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Object — cloudflare.r2-delete-object

Deletes an object from an R2 bucket.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.object_key string Required The key (name) of the object to delete. May contain slashes for path-like keys. Slashes (/) within the key MUST be sent literally and MUST NOT be percent-encoded (i.e. %2F); other reserved characters should be percent-encoded as usual.
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket",
    "object_key": "path/to/my-object.txt"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable Sippy — cloudflare.r2-delete-bucket-sippy-config

Disables Sippy on-demand migration for an R2 bucket. Requests no longer fetch missing objects from the source storage provider. Objects already copied to R2 remain in the bucket.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bucket_name": "example-bucket",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Sippy Configuration — cloudflare.r2-get-bucket-sippy-config

Gets configuration for Sippy for an existing R2 bucket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
path.bucket_name — Required $ref: "#/definitions/r2_bucket_name"
headers object Optional additionalProperties: false
headers.cf-r2-jurisdiction string Optional Jurisdiction where objects in this bucket are guaranteed to be stored. enum: ["default","eu","us","fedramp","fedramp-high"]; default: "default"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bucket_name": "example-bucket"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Account-Level Metrics — cloudflare.r2-get-account-level-metrics

Get Storage/Object Count Metrics across all buckets in your account. Note that Account-Level Metrics may not immediately reflect the latest data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Temporary Access Credentials — cloudflare.r2-create-temp-access-credentials

Creates temporary access credentials on a bucket that can be optionally scoped to prefixes or objects.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/r2_account_identifier"
body — Required $ref: "#/definitions/r2_temp_access_creds_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "bucket": "example-bucket",
    "objects": [
      "example-object"
    ],
    "parentAccessKeyId": "example-access-key-id",
    "permission": "object-read-write",
    "prefixes": [
      "example-prefix/"
    ],
    "ttlSeconds": 3600
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all apps — cloudflare.get_apps

Fetch all apps for your account

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
query object Optional additionalProperties: false
query.page_no integer Optional The page number from which you want your page search results to be displayed. default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 20; minimum: 1
query.search string Optional Search string that matches apps by name. maxLength: 125
query.sort_order string Optional Sort order for apps by creation time. enum: ["ASC","DESC"]; default: "DESC"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create App — cloudflare.create_app

Create new app for your account

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
body object Required
body.name string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch app details — cloudflare.get_app

Fetch details for an app in your account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an app — cloudflare.update_app

Update the name of an app in your account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id string Required format: "uuid"
body object Required additionalProperties: false
body.name string Required The app name. Leading and trailing whitespace is removed, and the name must contain at least one non-whitespace character. maxLength: 150; pattern: "\\S"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch day-wise session and recording analytics data for an App — cloudflare.get-org-analytics

Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.start_date string Optional start date in YYYY-MM-DD format
query.end_date string Optional end date in YYYY-MM-DD format

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch day-wise analytics data for your livestreams — cloudflare.get-livestream-analytics-daywise

Returns day-wise livestream analytics for the specified time range.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.start_time integer Optional Specify the start time as a Unix timestamp in seconds to access the livestream analytics.
query.end_time integer Optional Specify the end time as a Unix timestamp in seconds to access the livestream analytics.
query.filters string Optional Optional filters for livestream analytics.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch complete analytics data for your livestreams — cloudflare.get-livestream-analytics-complete

Returns livestream analytics for the specified time range.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.start_time integer Optional Specify the start time as a Unix timestamp in seconds to access the livestream analytics.
query.end_time integer Optional Specify the end time as a Unix timestamp in seconds to access the livestream analytics.
query.filters string Optional Optional filters for livestream analytics.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all livestreams — cloudflare.fetch_all_livestreams

Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the exclude_meetings query parameter.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.exclude_meetings boolean Optional Exclude the RealtimeKit meetings that are livestreamed. default: false
query.per_page integer Optional Number of results per page.
query.page_no integer Optional The page number from which you want your page search results to be displayed.
query.status string Optional Specifies the status of the operation. enum: ["LIVE","IDLE","ERRORED","INVOKED"]
query.start_time string Optional Specify the start time range in ISO format to access the live stream. format: "date-time"
query.end_time string Optional Specify the end time range in ISO format to access the live stream. format: "date-time"
query.sort_order string Optional Specifies the sorting order for the results. enum: ["ASC","DSC"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch livestream session details using livestream session ID — cloudflare.get-v2-livestreams-livestream-session-id

Returns livestream session details for the given livestream session ID. Retrieve the livestream_session_idusing the Fetch livestream session details using a session ID API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.livestream-session-id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "livestream-session-id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch livestream details using livestream ID — cloudflare.get-v2-livestream-session-livestream-id

Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.livestream_id string Required
query object Optional additionalProperties: false
query.page_no integer Optional The page number from which you want your page search results to be displayed.
query.per_page integer Optional Number of results per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "livestream_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch active livestream session details — cloudflare.get-v2-active-livestream-session-details

Returns details of all active livestreams for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.livestream_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "livestream_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all meetings for an App — cloudflare.get_all_meetings

Returns all meetings for the given App ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.page_no number Optional The page number from which you want your page search results to be displayed. minimum: 0
query.per_page number Optional Number of results per page minimum: 0
query.start_time string Optional The start time range for which you want to retrieve the meetings. The time must be specified in ISO format. format: "date-time"
query.end_time string Optional The end time range for which you want to retrieve the meetings. The time must be specified in ISO format. format: "date-time"
query.search string Optional The search query string. You can search using the meeting ID or title.
query.status string Optional Filter meetings by status. enum: ["ACTIVE","INACTIVE"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a meeting — cloudflare.create_meeting

Create a meeting for the given App ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
body object Required
body.ai_config — Optional $ref: "#/definitions/realtimekit_AIConfig"
body.live_stream_on_start boolean | null Optional Specifies if the meeting should start getting livestreamed on start. default: false
body.persist_chat boolean Optional If a meeting is set to persist_chat, meeting chat would remain for a week within the meeting space. default: false
body.record_on_start boolean | null Optional Specifies if the meeting should start getting recorded as soon as someone joins the meeting. default: false
body.recording_config — Optional $ref: "#/definitions/realtimekit_RecordingConfig"
body.session_keep_alive_time_in_secs number Optional Time in seconds, for which a session remains active, after the last participant has left the meeting. default: 60; minimum: 60; maximum: 600
body.summarize_on_end boolean Optional Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. default: false
body.title string | null Optional Title of the meeting
body.transcribe_on_end boolean Optional Automatically generate transcripts when the meeting ends. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch a meeting for an App — cloudflare.get_meeting

Returns a meeting details in an App for the given meeting ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. Fetch the meeting ID using the create a meeting API. format: "uuid"
query object Optional additionalProperties: false
query.name string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a meeting — cloudflare.update_meeting

Updates a meeting in an App for the given meeting ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. Fetch the meeting ID using the create a meeting API. format: "uuid"
body object Required
body.ai_config — Optional $ref: "#/definitions/realtimekit_AIConfig"
body.live_stream_on_start boolean Optional Specifies if the meeting should start getting livestreamed on start.
body.persist_chat boolean Optional If a meeting is updated to persist_chat, meeting chat would remain for a week within the meeting space.
body.record_on_start boolean Optional Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
body.recording_config — Optional $ref: "#/definitions/realtimekit_RecordingConfig"
body.session_keep_alive_time_in_secs number Optional Time in seconds, for which a session remains active, after the last participant has left the meeting. minimum: 60; maximum: 600
body.status string Optional Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting. enum: ["ACTIVE","INACTIVE"]
body.summarize_on_end boolean Optional Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
body.title string Optional Title of the meeting
body.transcribe_on_end boolean Optional Automatically generate transcripts when the meeting ends.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace a meeting — cloudflare.replace_meeting

Replaces all the details for the given meeting ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. Fetch the meeting ID using the create a meeting API. format: "uuid"
body object Required
body.ai_config — Optional $ref: "#/definitions/realtimekit_AIConfig"
body.live_stream_on_start boolean | null Optional Specifies if the meeting should start getting livestreamed on start. default: false
body.persist_chat boolean Optional If a meeting is set to persist_chat, meeting chat would remain for a week within the meeting space. default: false
body.record_on_start boolean | null Optional Specifies if the meeting should start getting recorded as soon as someone joins the meeting. default: false
body.recording_config — Optional $ref: "#/definitions/realtimekit_RecordingConfig"
body.session_keep_alive_time_in_secs number Optional Time in seconds, for which a session remains active, after the last participant has left the meeting. default: 60; minimum: 60; maximum: 600
body.summarize_on_end boolean Optional Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. default: false
body.title string | null Optional Title of the meeting
body.transcribe_on_end boolean Optional Automatically generate transcripts when the meeting ends. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch active livestreams for a meeting — cloudflare.get-v2-meetings-meetingid-active-livestream

Returns details of all active livestreams for the given meeting ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop livestreaming a meeting — cloudflare.stop_livestreaming

Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch details of an active session — cloudflare.getactivesession

Returns details of an ongoing active session for the given meeting ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Kick participants from an active session — cloudflare.kickpartcipants

Kicks one or more participants from an active session using user ID or custom participant ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting
body object Required
body.custom_participant_ids array Optional minItems: 1
body.custom_participant_ids[] string Optional
body.participant_ids array Optional minItems: 1
body.participant_ids[] string Optional format: "uuid"
body — Required anyOf[1]
body — Required anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "example"
  },
  "body": {
    "participant_ids": [
      "00000000-0000-4000-8000-000000000000"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Kick all participants — cloudflare.kickallparticipants

Kicks all participants from an active session for the given meeting ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mute participants of an active session — cloudflare.muteparticipants

Mutes one or more participants from an active session using user ID or custom participant ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting
body object Required
body.custom_participant_ids array Optional minItems: 1
body.custom_participant_ids[] string Optional
body.participant_ids array Optional minItems: 1
body.participant_ids[] string Optional
body — Required anyOf[1]
body — Required anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "example"
  },
  "body": {
    "participant_ids": [
      "example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mute all participants — cloudflare.muteallparticipants

Mutes all participants of an active session for the given meeting ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting
body object Required
body.allow_unmute boolean Optional if false, participants won't be able to unmute themselves after they are muted default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a poll — cloudflare.createpoll

Creates a new poll in an active session for the given meeting ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting
body object Required
body.anonymous boolean Optional if voters on a poll are anonymous
body.hide_votes boolean Optional if votes on an option are visible before a person votes
body.options array Required Different options for the question
body.options[] string Optional
body.question string Required Question of the poll

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "example"
  },
  "body": {
    "question": "example",
    "options": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch livestream session details for a meeting — cloudflare.livestream-session-details

Returns livestream session details for the given meeting ID. Retreive the meeting ID using the Create a meeting API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting format: "uuid"
query object Optional additionalProperties: false
query.page_no integer Optional The page number from which you want your page search results to be displayed.
query.per_page integer Optional Number of results per page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start livestreaming a meeting — cloudflare.start-livestreaming

Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting format: "uuid"
body object Required
body.name string | null Optional pattern: "^[a-zA-Z0-9-_]*$"
body.video_config object Optional
body.video_config.height integer Optional Height of the livestreaming video in pixels
body.video_config.width integer Optional Width of the livestreaming video in pixels

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "prdmmp-xhycsl"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all participants of a meeting — cloudflare.get_meeting_participants

Returns all participants detail for the given meeting ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. Fetch the meeting ID using the create a meeting API. format: "uuid"
query object Optional additionalProperties: false
query.page_no number Optional The page number from which you want your page search results to be displayed. minimum: 0
query.per_page number Optional Number of results per page minimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a participant — cloudflare.add_participant

Adds a participant to the given meeting ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. Fetch the meeting ID using the create a meeting API. format: "uuid"
body object Required
body.custom_participant_id string Required A unique participant ID. You must specify a unique ID for the participant, for example, UUID, email address, and so on.
body.name string | null Optional (Optional) Name of the participant.
body.picture string | null Optional (Optional) A URL to a picture to be used for the participant. format: "uri"
body.preset_name string Required Name of the preset to apply to this participant. default: "group_call_host"
body.token — Optional $ref: "#/definitions/realtimekit_ParticipantTokenValidity"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "preset_name": "group_call_host",
    "custom_participant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a participant — cloudflare.delete_meeting_participant

Deletes a participant for the given meeting and participant ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. You can fetch the meeting ID using the create a meeting API. format: "uuid"
path.participant_id string Required ID of the participant. You can fetch the participant ID using the add a participant API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000",
    "participant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch a participant's detail — cloudflare.get_meeting_participant

Returns a participant details for the given meeting and participant ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. You can fetch the meeting ID using the create a meeting API. format: "uuid"
path.participant_id string Required ID of the participant. You can fetch the participant ID using the add a participant API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000",
    "participant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a participant's detail — cloudflare.edit_participant

Updates a participant's details for the given meeting and participant ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. You can fetch the meeting ID using the create a meeting API. format: "uuid"
path.participant_id string Required ID of the participant. You can fetch the participant ID using the add a participant API.
body object Required
body.name string | null Optional (Optional) Name of the participant.
body.picture string | null Optional (Optional) A URL to a picture to be used for the participant. format: "uri"
body.preset_name string | null Optional (Optional) Name of the preset to apply to this participant.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000",
    "participant_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace a participant's detail — cloudflare.replace_participant

Replaces a participant's details for the given meeting and participant ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. You can fetch the meeting ID using the create a meeting API. format: "uuid"
path.participant_id string Required ID of the participant. You can fetch the participant ID using the add a participant API.
body object Required
body.custom_participant_id string Required Unique participant ID accepted by the replace participant API.
body.name string | null Optional (Optional) Name of the participant.
body.picture string | null Optional (Optional) A URL to a picture to be used for the participant. format: "uri"
body.preset_name string Required Name of the preset to apply to this participant.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000",
    "participant_id": "example"
  },
  "body": {
    "preset_name": "example",
    "custom_participant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke participant's authentication token — cloudflare.revoke_token

Revokes a previously issued participant authentication token without deleting the participant. Other tokens issued to the participant remain valid.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. You can fetch the meeting ID using the create a meeting API. format: "uuid"
path.participant_id string Required ID of the participant. You can fetch the participant ID using the add a participant API.
body object Required
body.token string Required The participant authentication token to revoke.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000",
    "participant_id": "example"
  },
  "body": {
    "token": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Refresh participant's authentication token — cloudflare.regenerate_token

Regenerates participant's authentication token for the given meeting and participant ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting. You can fetch the meeting ID using the create a meeting API. format: "uuid"
path.participant_id string Required ID of the participant. You can fetch the participant ID using the add a participant API.
body — Optional $ref: "#/definitions/realtimekit_ParticipantTokenValidity"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "00000000-0000-4000-8000-000000000000",
    "participant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all presets — cloudflare.get-presets

Fetches all the presets belonging to an App.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.per_page number Optional Number of results per page minimum: 0
query.page_no number Optional The page number from which you want your page search results to be displayed. minimum: 0
query.search string Optional Search presets by name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a preset — cloudflare.post-presets

Creates a preset belonging to the current App

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
body — Required $ref: "#/definitions/realtimekit_Preset"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  },
  "body": {
    "name": "example",
    "config": {
      "view_type": "GROUP_CALL",
      "max_video_streams": {
        "mobile": 1,
        "desktop": 1
      },
      "max_screenshare_count": 1,
      "media": {
        "video": {
          "quality": "hd",
          "frame_rate": 1
        },
        "screenshare": {
          "quality": "hd",
          "frame_rate": 1
        }
      }
    },
    "permissions": {
      "accept_waiting_requests": false,
      "can_accept_production_requests": false,
      "can_edit_display_name": false,
      "can_spotlight": false,
      "recorder_type": "RECORDER",
      "disable_participant_audio": false,
      "disable_participant_screensharing": false,
      "disable_participant_video": false,
      "kick_participant": false,
      "pin_participant": false,
      "can_record": false,
      "can_livestream": false,
      "waiting_room_type": "SKIP",
      "plugins": {
        "can_close": false,
        "can_start": false,
        "can_edit_config": false,
        "config": {}
      },
      "connected_meetings": {
        "can_alter_connected_meetings": false,
        "can_switch_connected_meetings": false,
        "can_switch_to_parent_meeting": false
      },
      "polls": {
        "can_create": false,
        "can_vote": false,
        "can_view": false
      },
      "media": {
        "video": {
          "can_produce": "ALLOWED"
        },
        "audio": {
          "can_produce": "ALLOWED"
        },
        "screenshare": {
          "can_produce": "ALLOWED"
        }
      },
      "chat": {
        "public": {
          "can_send": false,
          "text": false,
          "files": false
        },
        "private": {
          "can_send": false,
          "can_receive": false,
          "text": false,
          "files": false
        }
      },
      "hidden_participant": false,
      "show_participant_list": false,
      "can_change_participant_permissions": false
    },
    "ui": {
      "design_tokens": {
        "border_radius": "sharp",
        "border_width": "none",
        "spacing_base": 1,
        "theme": "darkest",
        "colors": {
          "brand": {
            "300": "example",
            "400": "example",
            "500": "example",
            "600": "example",
            "700": "example"
          },
          "background": {
            "600": "example",
            "700": "example",
            "800": "example",
            "900": "example",
            "1000": "example"
          },
          "danger": "example",
          "text": "example",
          "text_on_brand": "example",
          "success": "example",
          "video_bg": "example",
          "warning": "example"
        }
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a preset — cloudflare.delete-presets-preset_id

Deletes a preset using the provided preset ID

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.preset_id string Required ID of the preset to fetch format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "preset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch details of a preset — cloudflare.get-presets-preset_id

Fetches details of a preset using the provided preset ID

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.preset_id string Required ID of the preset to fetch format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "preset_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a preset — cloudflare.patch-presets-preset_id

Update a preset by the provided preset ID

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.preset_id string Required ID of the preset to fetch format: "uuid"
body — Required $ref: "#/definitions/realtimekit_UpdatePreset"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "preset_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace a preset — cloudflare.put-presets-preset_id

Replace all details for the preset using the provided preset ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.preset_id string Required ID of the preset to replace format: "uuid"
body — Required $ref: "#/definitions/realtimekit_Preset"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "preset_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "example",
    "config": {
      "view_type": "GROUP_CALL",
      "max_video_streams": {
        "mobile": 1,
        "desktop": 1
      },
      "max_screenshare_count": 1,
      "media": {
        "video": {
          "quality": "hd",
          "frame_rate": 1
        },
        "screenshare": {
          "quality": "hd",
          "frame_rate": 1
        }
      }
    },
    "permissions": {
      "accept_waiting_requests": false,
      "can_accept_production_requests": false,
      "can_edit_display_name": false,
      "can_spotlight": false,
      "recorder_type": "RECORDER",
      "disable_participant_audio": false,
      "disable_participant_screensharing": false,
      "disable_participant_video": false,
      "kick_participant": false,
      "pin_participant": false,
      "can_record": false,
      "can_livestream": false,
      "waiting_room_type": "SKIP",
      "plugins": {
        "can_close": false,
        "can_start": false,
        "can_edit_config": false,
        "config": {}
      },
      "connected_meetings": {
        "can_alter_connected_meetings": false,
        "can_switch_connected_meetings": false,
        "can_switch_to_parent_meeting": false
      },
      "polls": {
        "can_create": false,
        "can_vote": false,
        "can_view": false
      },
      "media": {
        "video": {
          "can_produce": "ALLOWED"
        },
        "audio": {
          "can_produce": "ALLOWED"
        },
        "screenshare": {
          "can_produce": "ALLOWED"
        }
      },
      "chat": {
        "public": {
          "can_send": false,
          "text": false,
          "files": false
        },
        "private": {
          "can_send": false,
          "can_receive": false,
          "text": false,
          "files": false
        }
      },
      "hidden_participant": false,
      "show_participant_list": false,
      "can_change_participant_permissions": false
    },
    "ui": {
      "design_tokens": {
        "border_radius": "sharp",
        "border_width": "none",
        "spacing_base": 1,
        "theme": "darkest",
        "colors": {
          "brand": {
            "300": "example",
            "400": "example",
            "500": "example",
            "600": "example",
            "700": "example"
          },
          "background": {
            "600": "example",
            "700": "example",
            "800": "example",
            "900": "example",
            "1000": "example"
          },
          "danger": "example",
          "text": "example",
          "text_on_brand": "example",
          "success": "example",
          "video_bg": "example",
          "warning": "example"
        }
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all recordings for an App — cloudflare.get_all_recordings

Returns all recordings for an App. If the meeting_id parameter is passed, returns all recordings for the given meeting ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.meeting_id string Optional ID of a meeting. Optional. Will limit results to only this meeting if passed. format: "uuid"
query.page_no number Optional The page number from which you want your page search results to be displayed. minimum: 0
query.per_page number Optional Number of results per page minimum: 0
query.expired boolean Optional If passed, only shows expired/non-expired recordings on RealtimeKit's bucket
query.search string Optional The search query string. You can search using the meeting ID or title.
query.sort_by string Optional enum: ["invokedTime"]
query.sort_order string Optional enum: ["ASC","DESC"]
query.start_time string Optional The start time range for which you want to retrieve the meetings. The time must be specified in ISO format. format: "date-time"
query.end_time string Optional The end time range for which you want to retrieve the meetings. The time must be specified in ISO format. format: "date-time"
query.status array Optional Filter by one or more recording status
query.status[] string Optional enum: ["INVOKED","RECORDING","UPLOADING","UPLOADED","ERRORED","PAUSED"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start recording a meeting — cloudflare.start_recording

Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
body object Required
body.allow_multiple_recordings boolean Optional By default, a meeting allows only one recording to run at a time. Enabling the allow_multiple_recordings parameter to true allows you to initiate multiple recordings concurrently in the same meeting. This allows you to record separate videos of the same meeting with different configurations, such as portrait mode or landscape mode. default: false
body.audio_config — Optional $ref: "#/definitions/realtimekit_AudioConfig"
body.file_name_prefix string Optional Update the recording file name.
body.interactive_config — Optional $ref: "#/definitions/realtimekit_InteractiveConfig"
body.max_seconds integer Optional Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. minimum: 60; maximum: 86400
body.meeting_id string Required ID of the meeting to record. format: "uuid"
body.realtimekit_bucket_config — Optional $ref: "#/definitions/realtimekit_realtimekitBucketConfig"
body.rtmp_out_config — Optional $ref: "#/definitions/realtimekit_LivestreamingConfig"
body.storage_config — Optional $ref: "#/definitions/realtimekit_StorageConfig"
body.url string Optional Pass a custom url to record arbitary screen format: "uri"
body.video_config — Optional $ref: "#/definitions/realtimekit_VideoConfig"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  },
  "body": {
    "allow_multiple_recordings": false,
    "audio_config": {
      "channel": "stereo",
      "codec": "AAC",
      "export_file": true
    },
    "file_name_prefix": "string",
    "interactive_config": {
      "type": "ID3"
    },
    "max_seconds": 60,
    "meeting_id": "97440c6a-140b-40a9-9499-b23fd7a3868a",
    "realtimekit_bucket_config": {
      "enabled": true
    },
    "video_config": {
      "codec": "H264",
      "export_file": true,
      "height": 720,
      "watermark": {
        "position": "left top",
        "size": {
          "height": 1,
          "width": 1
        },
        "url": "http://example.com"
      },
      "width": 1280
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch active recording — cloudflare.get_active_recording

Returns the active recording details for the given meeting ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.meeting_id string Required ID of the meeting

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start recording participant audio tracks — cloudflare.starttrackrecordingforameeting

Starts track recording for a meeting. Track recording currently records separate participant audio tracks as WebM files in the RealtimeKit bucket. Video track recording is in development. For more information, refer to Track recording.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
body object Required
body.layers object Optional Optional audio layer configuration. If omitted, RealtimeKit records all participant audio using the default file name prefix. additionalProperties: {"$ref":"#/definitions/realtimekit_TrackConfigLayer"}
body.meeting_id string Required ID of the meeting to record. format: "uuid"
body.user_ids array Optional Optional list of participant user IDs to record. Selective track recording (user_ids) is in early beta contact support to use this feature. minItems: 1; maxItems: 100
body.user_ids[] string Optional minLength: 1; maxLength: 256

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  },
  "body": {
    "meeting_id": "97440c6a-140b-40a9-9499-b23fd7a3868a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch details of a recording — cloudflare.get_one_recording

Returns details of a recording for the given recording ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.recording_id string Required ID of the recording format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "recording_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pause/Resume/Stop recording — cloudflare.pause_resume_stop_recording

Pause/Resume/Stop a given recording ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.recording_id string Required ID of the recording format: "uuid"
body object Required
body.action string Required enum: ["stop","pause","resume"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "recording_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "action": "stop"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all sessions of an App — cloudflare.getsessions

Returns details of all sessions of an App.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
query object Optional additionalProperties: false
query.page_no number Optional The page number from which you want your page search results to be displayed. minimum: 0
query.per_page number Optional Number of results per page minimum: 0
query.sort_by string Optional enum: ["minutesConsumed","createdAt"]
query.sort_order string Optional enum: ["ASC","DESC"]
query.start_time string Optional The start time range for which you want to retrieve the meetings. The time must be specified in ISO format. format: "date-time"
query.end_time string Optional The end time range for which you want to retrieve the meetings. The time must be specified in ISO format. format: "date-time"
query.participants string Optional
query.status string Optional enum: ["LIVE","ENDED"]
query.search string Optional Search string that matches sessions based on meeting title, meeting ID, and session ID
query.associated_id string Optional ID of the meeting that sessions should be associated with format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch details of peer — cloudflare.getparticipantdatafrompeerid

Returns participant details for the given peer ID along with call statistics.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.peer_id string Required ID of the peer format: "uuid"
query object Optional additionalProperties: false
query.filters string Optional Filter to apply to the peer report. enum: ["device_info","ip_information","precall_network_information","events","quality_stats"]
query.include_peer_events boolean Optional if true, response includes all the peer events of participant. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "peer_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch details of a session — cloudflare.getsessiondetails

Returns data of the given session ID including recording details.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.session_id string Required ID of the session format: "uuid"
query object Optional additionalProperties: false
query.include_breakout_rooms boolean Optional List all breakout rooms default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all chat messages of a session — cloudflare.getsessionchat

Returns a URL to download all chat messages of the session ID in CSV format.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.session_id string Required ID of the session format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch livestream session details using a session ID — cloudflare.get-v2-livestreamsession-session-meetingid-active-livestream

Returns livestream session details for the given session ID. Retreive the session ID using the Fetch all sessions of an App API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.session_id string Required format: "uuid"
query object Optional additionalProperties: false
query.per_page number Optional Number of results per page.
query.page_no number Optional The page number from which you want your page search results to be displayed.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch participants list of a session — cloudflare.getsessionparticipants

Returns a list of participants for the given session ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.session_id string Required ID of the session format: "uuid"
query object Optional additionalProperties: false
query.search string Optional The search query string. You can search using participant ID, custom participant ID, or display name.
query.page_no number Optional The page number from which you want your page search results to be displayed. minimum: 0
query.per_page integer Optional Number of results per page. default: 25; minimum: 1; maximum: 200
query.sort_order string Optional enum: ["ASC","DESC"]
query.sort_by string Optional enum: ["joinedAt","duration"]
query.include_peer_events boolean Optional if true, response includes all the peer events of participants. default: false
query.view string Optional In breakout room sessions, the view parameter can be set to raw for session specific duration for participants or consolidated to accumulate breakout room durations. enum: ["raw","consolidated"]; default: "raw"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch details of a participant — cloudflare.getparticipantdetails

Returns details of the given participant ID for the given session ID. Use the peer report endpoint to retrieve call statistics.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.participant_id string Required ID of the participant format: "uuid"
path.session_id string Required ID of the session format: "uuid"
query object Optional additionalProperties: false
query.include_peer_events boolean Optional if true, response includes all the peer events of participant. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "participant_id": "00000000-0000-4000-8000-000000000000",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch summary of transcripts for a session — cloudflare.getsessionsummary

Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.session_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate summary of Transcripts for the session — cloudflare.post-sessions-session_id-summary

Trigger Summary generation of Transcripts for the session ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.session_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch the complete transcript for a session — cloudflare.getsessiontranscript

Returns a URL to download the transcript for the session ID in CSV format.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.session_id string Required ID of the session format: "uuid"
query object Optional additionalProperties: false
query.format string Optional Transcript file format to fetch. enum: ["SRT","VTT","JSON","CSV"]; default: "CSV"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "session_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all webhooks details — cloudflare.getallwebhooks

Returns details of all webhooks for an App.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a webhook — cloudflare.addwebhook

Adds a new webhook to an App.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
body — Required $ref: "#/definitions/realtimekit_WebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  },
  "body": {
    "name": "All events webhook",
    "url": "https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e",
    "events": [
      "meeting.started",
      "meeting.ended",
      "meeting.participantJoined",
      "meeting.participantLeft",
      "meeting.chatSynced",
      "recording.statusUpdate",
      "livestreaming.statusUpdate",
      "meeting.transcript",
      "meeting.summary"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch all supported webhook events — cloudflare.getallwebhookevents

Returns the list of webhook event names supported by RealtimeKit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch details of a webhook — cloudflare.getwebhook

Returns webhook details for the given webhook ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.webhook_id string Required ID of the webhook format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "webhook_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a webhook — cloudflare.editwebhook

Edits the webhook details for the given webhook ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.webhook_id string Required ID of the webhook format: "uuid"
body — Required $ref: "#/definitions/realtimekit_PatchWebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "webhook_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace a webhook — cloudflare.replacewebhook

Replace all details for the given webhook ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/realtimekit_account_identifier"
path.app_id — Required $ref: "#/definitions/realtimekit_app_id"
path.webhook_id string Required ID of the webhook format: "uuid"
body — Required $ref: "#/definitions/realtimekit_WebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "app_id": "14a396e7-ca44-4937-bf1f-050a69118543",
    "webhook_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "All events webhook",
    "url": "https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e",
    "events": [
      "meeting.started",
      "meeting.ended",
      "meeting.participantJoined",
      "meeting.participantLeft",
      "meeting.chatSynced",
      "recording.statusUpdate",
      "livestreaming.statusUpdate",
      "meeting.transcript",
      "meeting.summary"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check domain availability — cloudflare.sandbox-registrar-domain-discovery-check

Performs real-time, authoritative availability checks directly against domain registries. Use this endpoint to verify a domain is available before attempting registration via POST /registrations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api-sandbox_identifier"
body — Required $ref: "#/definitions/registrar-api-sandbox_domain_check_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "domains": [
      "example.com",
      "example.net"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List extensions — cloudflare.sandbox-registrar-extension-list

Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on each supported extension (TLD).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/registrar-api-sandbox_identifier"
query object Optional additionalProperties: false
query.name string Optional Filter extensions by exact name match. For example, name=com returns only the com extension.
query.cursor string Optional Opaque token from a previous response's result_info.cursor. Pass this value to fetch the next page of results. Omit (or pass an empty string) for the first page. maxLength: 256
query.per_page integer Optional Number of items to return per page. default: 20; minimum: 1; maximum: 50
query.direction string Optional Sort direction for results. Defaults to ascending order. enum: ["asc","desc"]; default: "asc"
query.sort_by string Optional Column to sort results by. Defaults to name when omitted. enum: ["name","created_at","updated_at"]; default: "name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get extension — cloudflare.sandbox-registrar-extension-get

Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on a specific extension (TLD).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/registrar-api-sandbox_identifier"
path.extension string Required The extension name (e.g., com, co.uk).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "extension": "com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Registrations — cloudflare.sandbox-registrar-domain-registration-list

Returns a paginated list of domain registrations owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. $ref: "#/definitions/registrar-api-sandbox_identifier"
query object Optional additionalProperties: false
query.cursor string Optional Opaque token from a previous response's result_info.cursor. Pass this value to fetch the next page of results. Omit (or pass an empty string) for the first page. maxLength: 256
query.per_page integer Optional Number of items to return per page. default: 20; minimum: 1; maximum: 50
query.direction string Optional Sort direction for results. Defaults to ascending order. enum: ["asc","desc"]; default: "asc"
query.sort_by string Optional Column to sort results by. Defaults to registration date (registry_created_at) when omitted. enum: ["registry_created_at","registry_expires_at","name"]; default: "registry_created_at"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Registration — cloudflare.sandbox-registrar-domain-registration-create

Starts a domain registration workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api-sandbox_identifier"
headers object Optional additionalProperties: false
headers.Prefer string Optional Set to respond-async to receive an immediate 202 Accepted without waiting for the operation to complete (RFC 7240). The header may be combined with other preferences using standard comma-separated syntax.
body — Required $ref: "#/definitions/registrar-api-sandbox_registration_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Registration — cloudflare.sandbox-registrar-domain-registration-get

Returns the current state of a domain registration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. $ref: "#/definitions/registrar-api-sandbox_identifier"
path.domain_name — Required Domain name to retrieve. $ref: "#/definitions/registrar-api-sandbox_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Registration Status — cloudflare.sandbox-registrar-domain-registration-get-status

Returns the current status of a domain registration workflow.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api-sandbox_identifier"
path.domain_name — Required $ref: "#/definitions/registrar-api-sandbox_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Update Status — cloudflare.sandbox-registrar-domain-registration-get-update-status

Returns the current status of a domain update workflow.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. $ref: "#/definitions/registrar-api-sandbox_identifier"
path.domain_name — Required $ref: "#/definitions/registrar-api-sandbox_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check domain availability — cloudflare.registrar-domain-discovery-check

Performs real-time, authoritative availability checks directly against domain registries. Use this endpoint to verify a domain is available before attempting registration via POST /registrations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api_identifier"
body — Required $ref: "#/definitions/registrar-api_domain_check_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "domains": [
      "example.com",
      "example.net"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check domain transfer eligibility — cloudflare.registrar-domain-discovery-transfer-check

Performs real-time, authoritative eligibility checks directly against needed requirements. Use this endpoint to verify a domain is available before attempting a transfer via POST /registrations/:domain_name/transfer-in.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api_identifier"
body — Required $ref: "#/definitions/registrar-api_domain_transfer_check_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "domains": [
      {
        "domain_name": "example.com"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List extensions — cloudflare.registrar-extension-list

Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on each supported extension (TLD).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/registrar-api_identifier"
query object Optional additionalProperties: false
query.name string Optional Filter extensions by exact name match. For example, name=com returns only the com extension.
query.cursor string Optional Opaque token from a previous response's result_info.cursor. Pass this value to fetch the next page of results. Omit (or pass an empty string) for the first page. maxLength: 256
query.per_page integer Optional Number of items to return per page. default: 20; minimum: 1; maximum: 50
query.direction string Optional Sort direction for results. Defaults to ascending order. enum: ["asc","desc"]; default: "asc"
query.sort_by string Optional Column to sort results by. Defaults to name when omitted. enum: ["name","created_at","updated_at"]; default: "name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get extension — cloudflare.registrar-extension-get

Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on a specific extension (TLD).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/registrar-api_identifier"
path.extension string Required The extension name (e.g., com, co.uk).

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "extension": "com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Registrations — cloudflare.registrar-domain-registration-list

Returns a paginated list of domain registrations owned by the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. $ref: "#/definitions/registrar-api_identifier"
query object Optional additionalProperties: false
query.cursor string Optional Opaque token from a previous response's result_info.cursor. Pass this value to fetch the next page of results. Omit (or pass an empty string) for the first page. maxLength: 256
query.per_page integer Optional Number of items to return per page. default: 20; minimum: 1; maximum: 50
query.direction string Optional Sort direction for results. Defaults to ascending order. enum: ["asc","desc"]; default: "asc"
query.sort_by string Optional Column to sort results by. Defaults to registration date (registry_created_at) when omitted. enum: ["registry_created_at","registry_expires_at","name"]; default: "registry_created_at"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Registration — cloudflare.registrar-domain-registration-create

Starts a domain registration workflow. This is a billable operation — successful registration charges the account's default payment method. All successful domain registrations are non-refundable — once the workflow completes with state: succeeded, the charge cannot be reversed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api_identifier"
headers object Optional additionalProperties: false
headers.Prefer string Optional Set to respond-async to receive an immediate 202 Accepted without waiting for the operation to complete (RFC 7240). The header may be combined with other preferences using standard comma-separated syntax.
body — Required $ref: "#/definitions/registrar-api_registration_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Registration — cloudflare.registrar-domain-registration-get

Returns the current state of a domain registration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. $ref: "#/definitions/registrar-api_identifier"
path.domain_name — Required Domain name to retrieve. $ref: "#/definitions/registrar-api_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Registration Status — cloudflare.registrar-domain-registration-get-status

Returns the current status of a domain registration workflow.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api_identifier"
path.domain_name — Required $ref: "#/definitions/registrar-api_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Initiate Transfer — cloudflare.registrar-domain-transfer-in-create

Starts a domain transfer-in workflow. This is typically a billable operation — successful transfers charge the account's default payment method, except for extensions with zero transfer pricing (e.g. UK extensions). All successful domain transfers are non-refundable.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api_identifier"
path.domain_name — Required Domain name to transfer. $ref: "#/definitions/registrar-api_domain_name"
headers object Optional additionalProperties: false
headers.Prefer string Optional Set to respond-async to indicate a preference for asynchronous processing (RFC 7240).
body — Required $ref: "#/definitions/registrar-api_transfer_in_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Transfer Status — cloudflare.registrar-domain-transfer-get-status

Returns the current status of a domain transfer workflow.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. Required for all Registrar API operations. $ref: "#/definitions/registrar-api_identifier"
path.domain_name — Required $ref: "#/definitions/registrar-api_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Update Status — cloudflare.registrar-domain-registration-get-update-status

Returns the current status of a domain update workflow.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Cloudflare account ID. $ref: "#/definitions/registrar-api_identifier"
path.domain_name — Required $ref: "#/definitions/registrar-api_domain_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_name": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an account industry — cloudflare.reporting-industry-get

Gets the industry classification for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare public account ID (32-character hexadecimal string) minLength: 32; maxLength: 32; pattern: "^[a-f0-9]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an account industry — cloudflare.reporting-industry-update

Updates the industry classification for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare public account ID (32-character hexadecimal string) minLength: 32; maxLength: 32; pattern: "^[a-f0-9]{32}$"
body — Optional $ref: "#/definitions/reports_PatchAccountIndustryBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List reporting policies — cloudflare.reporting-policies-list

Lists all reporting policies for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare public account ID (32-character hexadecimal string) minLength: 32; maxLength: 32; pattern: "^[a-f0-9]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a reporting policy — cloudflare.reporting-policies-get

Gets a reporting policy by identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id string Required Unique identifier for the policy (UUID format) format: "uuid"
path.account_id string Required Cloudflare public account ID (32-character hexadecimal string) minLength: 32; maxLength: 32; pattern: "^[a-f0-9]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List generated reports — cloudflare.reporting-reports-list

Lists all generated reports for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare public account ID (32-character hexadecimal string) minLength: 32; maxLength: 32; pattern: "^[a-f0-9]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a generated report — cloudflare.reporting-reports-get

Gets a generated report by identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Cloudflare public account ID (32-character hexadecimal string) minLength: 32; maxLength: 32; pattern: "^[a-f0-9]{32}$"
path.report_id string Required Unique report identifier format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "report_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request Trace — cloudflare.account-request-tracer-request-trace

Traces a simulated HTTP request through Cloudflare's edge to analyze how rules, settings, and configurations would process the request. Useful for debugging firewall rules, page rules, and other request transformations without sending actual traffic. Supports custom headers, cookies, body content, and geolocation context.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/request-tracer_account_identifier"
body object Required
body.body object Optional
body.body.base64 string Optional Base64 encoded request body
body.body.json object Optional Arbitrary json as request body
body.body.plain_text string Optional Request body as plain text
body.context object Optional Additional request parameters
body.context.bot_score integer Optional Bot score used for evaluating tracing request processing
body.context.geoloc object Optional Geodata for tracing request
body.context.geoloc.city string Optional
body.context.geoloc.continent string Optional
body.context.geoloc.is_eu_country boolean Optional
body.context.geoloc.iso_code string Optional
body.context.geoloc.latitude number Optional
body.context.geoloc.longitude number Optional
body.context.geoloc.postal_code string Optional
body.context.geoloc.region_code string Optional
body.context.geoloc.subdivision_2_iso_code string Optional
body.context.geoloc.timezone string Optional
body.context.skip_challenge boolean Optional Whether to skip any challenges for tracing request (e.g.: captcha)
body.context.threat_score integer Optional Threat score used for evaluating tracing request processing
body.cookies object Optional Cookies added to tracing request additionalProperties: {"type":"string"}
body.headers object Optional Headers added to tracing request additionalProperties: {"type":"string"}
body.method string Required HTTP Method of tracing request
body.protocol string Optional HTTP Protocol of tracing request
body.skip_response boolean Optional Skip sending the request to the Origin server after all rules evaluation
body.url string Required URL to which perform tracing request

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "body": {
      "base64": "c29tZV9yZXF1ZXN0X2JvZHk="
    },
    "context": {
      "geoloc": {
        "city": "London"
      },
      "skip_challenge": true
    },
    "cookies": {
      "cookie_name_1": "cookie_value_1",
      "cookie_name_2": "cookie_value_2"
    },
    "headers": {
      "header_name_1": "header_value_1",
      "header_name_2": "header_value_2"
    },
    "method": "PUT",
    "protocol": "HTTP/1.1",
    "url": "https://some.zone/some_path"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List applications — cloudflare.getresourcelibraryapplications

List the applications available to an account, both the applications Cloudflare curates and the custom applications the account has defined.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.filter string Optional Filter applications using key:value format. Supported filter keys: - name: application name (for example, name:HR). - id: application ID (for example, id:498). - human_id: human-readable ID (for example, human_id:HR). - hostname: hostname or support domain (for example, hostname:portal.example.com). - source: application source name (for example, source:cloudflare). - ip_subnet: CIDR containment; returns applications where a stored subnet contains the search value (for example, ip_subnet:10.0.1.5/32 matches 10.0.0.0/16). - category_id: category ID (for example, category_id:12). - category_name: category name (for example, category_name:HR). - supported: supported Cloudflare product. Values: GATEWAY, ACCESS, CASB. - review_status: account-specific Gateway review status. Values: approved, unapproved, in_review, unreviewed.
query.limit integer Optional Number of results to return. Defaults to 25; values are clamped to 1–250. default: 25
query.offset integer Optional Number of results to skip. Defaults to 0; negative values are clamped to 0. Ignored when cursor is provided. default: 0
query.cursor string Optional Opaque value from result_info.cursor of the previous response. Returns the results that follow it. Send the same filter, search, lookup, and order_by values as the request that returned it; limit and fields may change. An empty value is the same as no cursor. A modified cursor, or one used with different values, returns 400.
query.order_by string Optional Order results using field:direction format. Supported fields are name, id, human_id, category_id, application_type, application_confidence_score, and gen_ai_score. Supported directions are asc and desc. Ignored when search is provided; results are ranked by relevance instead. Also ignored when lookup is provided.
query.search string Optional Fuzzy search across application name and hostnames. Results are ranked by relevance. Must be between 2 and 200 characters. Can be combined with filter parameters. minLength: 2; maxLength: 200
query.lookup string Optional Find complete, case-insensitive application name mentions in a phrase or rule sentence. Misspelled names do not match. Returns matching applications ranked by relevance. Must be between 2 and 1000 characters, with no control characters other than tab and line breaks. Uses the same filters, fields, and pagination as listing. search cannot be combined with lookup. Results are ranked by relevance, so order_by is ignored. To keep the text out of URLs, send it to POST .../applications/lookup instead. minLength: 2; maxLength: 1000
query.fields string Optional Return only the listed properties on each application, as a comma-separated list. Use this to keep responses small when you only need part of each application, for example populating a picker with fields=id,name instead of downloading every hostname and IP subnet. Omit this parameter to receive the full application object, including when lookup is used. id is always returned. Selectable properties: id, name, human_id, version, hostnames, support_domains, ip_subnets, port_protocols, supported, gen_ai_score, application_confidence_score, created_at, updated_at, review_status. Unknown or empty property names return 400.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create application — cloudflare.createresourcelibraryapplication

Create a custom application for an account from a name, category, and optional network matchers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body — Required $ref: "#/definitions/alexandria_create_application_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "HR",
    "human_id": "HR",
    "category_id": 12,
    "hostnames": [
      "example.com",
      "foo.com"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Look up applications in a rule sentence — cloudflare.lookupresourcelibraryapplications

Find complete application names mentioned in a rule sentence, ignoring case. Lookup does not correct misspellings. Matches are ranked by relevance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.filter string Optional Filter matches using the same key:value filters as the list endpoint.
query.limit integer Optional Maximum number of matches to return. Defaults to 25; values are clamped to 1–250. default: 25
query.fields string Optional Return only the listed properties on each application, as a comma-separated list. Accepts the same properties as the list endpoint. id is always returned. Omit this parameter to receive the full application object.
body — Required $ref: "#/definitions/alexandria_lookup_applications_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "lookup": "block access to Google Chat"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete application — cloudflare.deleteresourcelibraryapplication

Delete a custom application and all of its versions. Deletion is rejected when other resources reference the application.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.id — Required Application ID. $ref: "#/definitions/alexandria_application_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": 498
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get application — cloudflare.getresourcelibraryapplicationbyid

Retrieve an application available to the account by its numeric application ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.id — Required Application ID. $ref: "#/definitions/alexandria_application_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": 498
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update application — cloudflare.updateresourcelibraryapplication

Replace the supplied network matchers for a custom application and create a new version. Omitted matcher lists remain unchanged; send an empty list to clear a matcher type.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.id — Required Application ID. $ref: "#/definitions/alexandria_application_id"
body — Required $ref: "#/definitions/alexandria_update_application_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": 498
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List application categories — cloudflare.getresourcelibrarycategories

List the categories available for classifying applications, ordered by name. Results are paginated by offset or cursor.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.limit integer Optional Number of results to return. Defaults to 25; values are clamped to 1–250. default: 25
query.offset integer Optional Number of results to skip. Defaults to 0; negative values are clamped to 0. Ignored when cursor is provided. default: 0
query.cursor string Optional Opaque value from result_info.cursor of the previous response. Returns the categories that follow it. limit may change between requests. An empty value is the same as no cursor. A modified cursor, or one returned by a different list, returns 400.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get application category — cloudflare.getresourcelibrarycategorybyid

Retrieve an application category by its numeric ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
path.id — Required Application category ID. $ref: "#/definitions/alexandria_category_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": 12
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get lists — cloudflare.lists-get-lists

Fetches all lists in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/lists_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a list — cloudflare.lists-create-a-list

Creates a new list of the specified kind.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/lists_account_id"
body object Required
body.description — Optional $ref: "#/definitions/lists_description"
body.kind — Required $ref: "#/definitions/lists_kind"
body.name — Required $ref: "#/definitions/lists_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "list1",
    "kind": "ip"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get bulk operation status — cloudflare.lists-get-bulk-operation-status

Gets the current status of an asynchronous operation on a list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.operation_id — Required $ref: "#/definitions/lists_operation_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "operation_id": "4da8780eeb215e6cb7f48dd981c4ea02",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a list — cloudflare.lists-delete-a-list

Deletes a specific list and all its items.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a list — cloudflare.lists-get-a-list

Fetches the details of a list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a list — cloudflare.lists-update-a-list

Updates the description of a list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"
body object Required
body.description — Optional $ref: "#/definitions/lists_description"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete list items — cloudflare.lists-delete-list-items

Removes one or more items from a list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"
body object Required
body.items array Optional The list items to delete, identified by their unique IDs. minItems: 1
body.items[] object Optional
body.items[].id string Required Defines the unique ID of the item in the List. minLength: 32; maxLength: 32

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get list items — cloudflare.lists-get-list-items

Fetches all the items in the list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"
query object Optional additionalProperties: false
query.cursor string Optional The pagination cursor. An opaque string token that indicates where to continue when requesting the next/previous set of records. The response provides cursor values under result_info.cursors. You should make no assumptions about a cursor's content or length.
query.per_page integer Optional Amount of results to include in each paginated response. A non-negative 32 bit integer. minimum: 1; maximum: 500
query.search string Optional A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create list items — cloudflare.lists-create-list-items

Appends new items to the list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"
body — Required $ref: "#/definitions/lists_items-update-request-collection"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update all list items — cloudflare.lists-update-all-list-items

Removes all existing items from the list and adds the provided items to the list.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"
body — Required $ref: "#/definitions/lists_items-update-request-collection"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a list item — cloudflare.lists-get-a-list-item

Fetches a list item in the list.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.item_id — Required $ref: "#/definitions/lists_item_id"
path.list_id — Required $ref: "#/definitions/lists_list_id"
path.account_id — Required $ref: "#/definitions/lists_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "item_id": "34b12448945f11eaa1b71c4d701ab86e",
    "list_id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account rulesets — cloudflare.listaccountrulesets

Fetches all rulesets at the account level.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"
query object Optional additionalProperties: false
query.cursor — Optional $ref: "#/definitions/rulesets_Cursor"
query.per_page — Optional $ref: "#/definitions/rulesets_PerPage"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an account ruleset — cloudflare.createaccountruleset

Creates a ruleset at the account level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false
body — Required
body — Required allOf[1]; $ref: "#/definitions/rulesets_Ruleset"
body object Required allOf[2]
body.kind — Required allOf[2]; $ref: "#/definitions/rulesets_RulesetKind"
body.phase — Required allOf[2]; $ref: "#/definitions/rulesets_RulesetPhase"
body.rules — Optional allOf[2]; $ref: "#/definitions/rulesets_RequestRules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  },
  "body": {
    "name": "example",
    "kind": "root",
    "phase": "http_request_firewall_custom",
    "id": "2f2feab2026849078ba485f918791bdc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an account entry point ruleset — cloudflare.getaccountentrypointruleset

Fetches the latest version of the account entry point ruleset for a given phase.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_phase": "http_request_firewall_custom",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an account entry point ruleset — cloudflare.updateaccountentrypointruleset

Updates an account entry point ruleset, creating a new version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false
body — Required
body — Required allOf[1]; $ref: "#/definitions/rulesets_Ruleset"
body object Required allOf[2]
body.rules — Optional allOf[2]; $ref: "#/definitions/rulesets_RequestRules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_phase": "http_request_firewall_custom",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  },
  "body": {
    "id": "2f2feab2026849078ba485f918791bdc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List an account entry point ruleset's versions — cloudflare.listaccountentrypointrulesetversions

Fetches the versions of an account entry point ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_phase": "http_request_firewall_custom",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an account entry point ruleset version — cloudflare.getaccountentrypointrulesetversion

Fetches a specific version of an account entry point ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_version": "1",
    "ruleset_phase": "http_request_firewall_custom",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an account ruleset — cloudflare.deleteaccountruleset

Deletes all versions of an existing account ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an account ruleset — cloudflare.getaccountruleset

Fetches the latest version of an account ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an account ruleset — cloudflare.updateaccountruleset

Updates an account ruleset, creating a new version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false
body — Required
body — Required allOf[1]; $ref: "#/definitions/rulesets_Ruleset"
body object Required allOf[2]
body.kind — Optional allOf[2]; $ref: "#/definitions/rulesets_RulesetKind"
body.phase — Optional allOf[2]; $ref: "#/definitions/rulesets_RulesetPhase"
body.rules — Optional allOf[2]; $ref: "#/definitions/rulesets_RequestRules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  },
  "body": {
    "id": "2f2feab2026849078ba485f918791bdc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an account ruleset rule — cloudflare.deleteaccountrulesetrule

Deletes an existing rule from an account ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/rulesets_RuleId"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "3a03d665bac047339bb530ecb439a90d",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List an account ruleset's versions — cloudflare.listaccountrulesetversions

Fetches the versions of an account ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an account ruleset version — cloudflare.deleteaccountrulesetversion

Deletes an existing version of an account ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_version": "1",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an account ruleset version — cloudflare.getaccountrulesetversion

Fetches a specific version of an account ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_version": "1",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List an account ruleset version's rules by tag — cloudflare.listaccountrulesetversionrulesbytag

Fetches the rules of a managed account ruleset version for a given tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_tag — Required $ref: "#/definitions/rulesets_RuleCategory"
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.account_id — Required $ref: "#/definitions/rulesets_AccountId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_tag": "directory-traversal",
    "ruleset_version": "1",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "account_id": "abf9b32d38c5f572afde3336ec0ce302"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Web Analytics site — cloudflare.web-analytics-create-site

Creates a new Web Analytics site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
body — Required $ref: "#/definitions/rum_create-site-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Web Analytics sites — cloudflare.web-analytics-list-sites

Lists all Web Analytics sites of an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
query object Optional additionalProperties: false
query.per_page — Optional $ref: "#/definitions/rum_per_page"
query.page — Optional $ref: "#/definitions/rum_page"
query.order_by — Optional $ref: "#/definitions/rum_order_by"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Web Analytics site tags — cloudflare.web-analytics-list-site-tags

Returns all site tags for an account as an array of site tag strings. This endpoint returns all results without pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
query object Optional additionalProperties: false
query.all boolean Optional When true, includes sites that are disabled or paused.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate a Web Analytics site hostname — cloudflare.web-analytics-validate-site-hostname

Validates that the provided hostname is well-formed, does not contain wildcards, and has a valid TLD. Returns an empty result on success.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.hostname string Required The hostname to validate (e.g. example.com). The pattern below validates the hostname's structure (label syntax) only. In addition, the hostname must end in a valid public suffix (TLD). For the list of valid suffixes and how it is used, see the Public Suffix List: https://wiki.mozilla.org/Public_Suffix_List/Use_Cases maxLength: 253; pattern: "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9]?)\\.){1,}([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]?){2,}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hostname": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Web Analytics zone tags — cloudflare.web-analytics-list-zone-tags

Returns all zone tags associated with Web Analytics sites for an account. These can be used to filter or exclude zones in the zone selection input. This endpoint returns all results without pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Web Analytics site — cloudflare.web-analytics-delete-site

Deletes an existing Web Analytics site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.site_id — Required $ref: "#/definitions/rum_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Web Analytics site — cloudflare.web-analytics-get-site

Retrieves a Web Analytics site.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.site_id — Required $ref: "#/definitions/rum_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Web Analytics site — cloudflare.web-analytics-update-site

Updates an existing Web Analytics site.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.site_id — Required $ref: "#/definitions/rum_identifier"
body — Required $ref: "#/definitions/rum_update-site-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "site_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Web Analytics rule — cloudflare.web-analytics-create-rule

Creates a new rule in a Web Analytics ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.ruleset_id — Required $ref: "#/definitions/rum_ruleset_identifier"
body — Required $ref: "#/definitions/rum_create-rule-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ruleset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Web Analytics rule — cloudflare.web-analytics-delete-rule

Deletes an existing rule from a Web Analytics ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.ruleset_id — Required $ref: "#/definitions/rum_ruleset_identifier"
path.rule_id — Required $ref: "#/definitions/rum_rule_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ruleset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Web Analytics rule — cloudflare.web-analytics-update-rule

Updates a rule in a Web Analytics ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.ruleset_id — Required $ref: "#/definitions/rum_ruleset_identifier"
path.rule_id — Required $ref: "#/definitions/rum_rule_identifier"
body — Required $ref: "#/definitions/rum_create-rule-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ruleset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "rule_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List rules in Web Analytics ruleset — cloudflare.web-analytics-list-rules

Lists all the rules in a Web Analytics ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.ruleset_id — Required $ref: "#/definitions/rum_ruleset_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ruleset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Web Analytics rules — cloudflare.web-analytics-modify-rules

Modifies one or more rules in a Web Analytics ruleset with a single request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/rum_identifier"
path.ruleset_id — Required $ref: "#/definitions/rum_ruleset_identifier"
body — Required $ref: "#/definitions/rum_modify-rules-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ruleset_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SCIM Groups — cloudflare.scim-groups-list

Lists SCIM Group resources for the account. Returns both system groups (backed by Cloudflare permission groups, prefixed cloudflare-v1-) and custom user groups. Supports filtering by displayName using SCIM filter syntax.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.startIndex integer Optional The 1-based index of the first result in the current set of list results. Values less than 1 are treated as 1. default: 1; minimum: 1
query.count integer Optional Specifies the desired maximum number of query results per page. minimum: 0
query.filter string Optional SCIM filter expression (RFC 7644 Section 3.4.2.2). Only displayName eq "value" is supported.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create SCIM Group — cloudflare.scim-groups-create

Creates a new SCIM Group (user group) for the account. The displayName must not be empty and must not begin with CF (reserved for system groups).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required $ref: "#/definitions/iam_scim_group_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "displayName": "My IdP Group"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete SCIM Group — cloudflare.scim-groups-delete

Deletes a SCIM Group (custom user groups only). System groups backed by Cloudflare permission groups cannot be deleted via SCIM. Returns 204 No Content on success.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.group_id — Required $ref: "#/definitions/iam_scim_group_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "group_id": "cloudflare-v1-023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SCIM Group — cloudflare.scim-groups-get

Retrieves a single SCIM Group resource by group ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.group_id — Required $ref: "#/definitions/iam_scim_group_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "group_id": "cloudflare-v1-023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch SCIM Group — cloudflare.scim-groups-patch

Partially updates a SCIM Group via PATCH operations (RFC 7644 Section 3.5.2). Supports add, remove, and replace operations on members, displayName, and externalId. For system groups (prefixed cloudflare-v1-), only member management operations are supported.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.group_id — Required $ref: "#/definitions/iam_scim_group_identifier"
body — Required $ref: "#/definitions/iam_scim_group_patch_op_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "group_id": "cloudflare-v1-023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
      {
        "op": "add",
        "path": "members",
        "value": [
          {
            "value": "023e105f4ecef8ad9ca31a8372d0c353"
          }
        ]
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace SCIM Group — cloudflare.scim-groups-put

Replaces the mutable attributes of a SCIM Group (RFC 7644 Section 3.5.1), including its complete member set. Omitting externalId clears it, and omitting members replaces the member set with an empty list. For system groups (prefixed cloudflare-v1-), only the member set is replaced.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.group_id — Required $ref: "#/definitions/iam_scim_group_identifier"
body — Required $ref: "#/definitions/iam_scim_group_replace_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "group_id": "cloudflare-v1-023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "displayName": "My IdP Group"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SCIM Resource Types — cloudflare.scim-resource-types-list

Returns the list of SCIM resource types supported by the Cloudflare SCIM service (RFC 7643 Section 6, RFC 7644 Section 4). Clients use this to discover available resource categories (e.g. Users, Groups) and their associated schemas. Query parameters are not supported on this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SCIM Resource Type — cloudflare.scim-resource-types-get

Returns a single SCIM resource type by ID (RFC 7643 Section 6). Valid IDs are User and Group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.resource_type_id string Required The resource type identifier. enum: ["User","Group"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_type_id": "User"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SCIM Schemas — cloudflare.scim-schemas-list

Returns the list of SCIM schemas supported by the Cloudflare SCIM service (RFC 7643 Section 7, RFC 7644 Section 4). Clients use this to introspect the attributes of each resource type. Query parameters are not supported on this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SCIM Schema — cloudflare.scim-schemas-get

Returns a single SCIM schema definition by schema URI ID (RFC 7643 Section 7). Valid IDs are urn:ietf:params:scim:schemas:core:2.0:User and urn:ietf:params:scim:schemas:core:2.0:Group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.schema_id string Required The schema URI identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "schema_id": "urn:ietf:params:scim:schemas:core:2.0:User"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SCIM Service Provider Config — cloudflare.scim-service-provider-config-get

Returns the SCIM 2.0 Service Provider configuration (RFC 7643 Section 5). IdPs use this endpoint to auto-configure their SCIM integration with Cloudflare, discovering which optional features (patch, bulk, filter, etc.) are supported.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SCIM Users — cloudflare.scim-users-list

Lists account members as SCIM User resources. Supports optional filtering by userName (email) using the SCIM filter syntax (e.g. userName eq "[email protected]"). Pagination is controlled via startIndex and count query parameters per RFC 7644 Section 3.4.2.4.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.startIndex integer Optional The 1-based index of the first result in the current set of list results. Values less than 1 are treated as 1. default: 1; minimum: 1
query.count integer Optional Specifies the desired maximum number of query results per page. minimum: 0
query.filter string Optional SCIM filter expression (RFC 7644 Section 3.4.2.2). Only userName eq "value" is supported.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create SCIM User — cloudflare.scim-users-create

Provisions a new account member via SCIM. The userName field must be a valid email address and must match the primary email in emails. The account must be an Enterprise account with SCIM entitlements enabled.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required $ref: "#/definitions/iam_scim_user_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "userName": "[email protected]",
    "emails": [],
    "active": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete SCIM User — cloudflare.scim-users-delete

Deprovisions a SCIM User by removing their membership from this account (RFC 7644 Section 3.6). This does not delete the global Cloudflare user.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_id — Required $ref: "#/definitions/iam_scim_user_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SCIM User — cloudflare.scim-users-get

Retrieves a single account member as a SCIM User resource by user tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_id — Required $ref: "#/definitions/iam_scim_user_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch SCIM User — cloudflare.scim-users-patch

Partially updates a SCIM User via PATCH operations (RFC 7644 Section 3.5.2). Supports updating userName, name.givenName, name.familyName, and active. Setting active: false deprovisions the user (removes them from the account). For IdP compatibility, emails[type eq "work"].value is also accepted as an alias for userName.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_id — Required $ref: "#/definitions/iam_scim_user_identifier"
body — Required $ref: "#/definitions/iam_scim_patch_op_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
      {
        "op": "replace",
        "value": {
          "active": false
        }
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace SCIM User — cloudflare.scim-users-put

Replaces a SCIM User resource (RFC 7644 Section 3.5.1). Fully replaces the mutable attributes of the user. Supports updating userName, name, emails, and active.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.user_id — Required $ref: "#/definitions/iam_scim_user_identifier"
body — Required $ref: "#/definitions/iam_scim_user_replace_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "user_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "userName": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List ACLs — cloudflare.secondary-dns---acl--list-ac-ls

List ACLs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create ACL — cloudflare.secondary-dns---acl--create-acl

Create ACL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"
body object Required
body.ip_range — Required $ref: "#/definitions/secondary-dns_ip_range"
body.name — Required $ref: "#/definitions/secondary-dns_name-4"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "name": "my-acl-1",
    "ip_range": "192.0.2.53/28"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete ACL — cloudflare.secondary-dns---acl--delete-acl

Delete ACL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.acl_id — Required $ref: "#/definitions/secondary-dns_identifier-3"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "acl_id": "23ff594956f20c2a721606e94745a8aa",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

ACL Details — cloudflare.secondary-dns---acl--acl-details

Get ACL.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.acl_id — Required $ref: "#/definitions/secondary-dns_identifier-3"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "acl_id": "23ff594956f20c2a721606e94745a8aa",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update ACL — cloudflare.secondary-dns---acl--update-acl

Modify ACL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.acl_id — Required $ref: "#/definitions/secondary-dns_identifier-3"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"
body — Required $ref: "#/definitions/secondary-dns_acl"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "acl_id": "23ff594956f20c2a721606e94745a8aa",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "id": "23ff594956f20c2a721606e94745a8aa",
    "name": "my-acl-1",
    "ip_range": "192.0.2.53/28"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Peers — cloudflare.secondary-dns---peer--list-peers

List Peers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Peer — cloudflare.secondary-dns---peer--create-peer

Create Peer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"
body object Required
body.name — Required $ref: "#/definitions/secondary-dns_name-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "name": "my-peer-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Peer — cloudflare.secondary-dns---peer--delete-peer

Delete Peer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.peer_id — Required $ref: "#/definitions/secondary-dns_identifier-3"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "peer_id": "23ff594956f20c2a721606e94745a8aa",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Peer Details — cloudflare.secondary-dns---peer--peer-details

Get Peer.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.peer_id — Required $ref: "#/definitions/secondary-dns_identifier-3"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "peer_id": "23ff594956f20c2a721606e94745a8aa",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Peer — cloudflare.secondary-dns---peer--update-peer

Modify Peer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.peer_id — Required $ref: "#/definitions/secondary-dns_identifier-3"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"
body — Required $ref: "#/definitions/secondary-dns_peer"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "peer_id": "23ff594956f20c2a721606e94745a8aa",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "id": "23ff594956f20c2a721606e94745a8aa",
    "name": "my-peer-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List TSIGs — cloudflare.secondary-dns---tsig--list-tsi-gs

List TSIGs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create TSIG — cloudflare.secondary-dns---tsig--create-tsig

Create TSIG.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"
body — Required $ref: "#/definitions/secondary-dns_tsig"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "tsig.customer.cf.",
    "secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
    "algo": "hmac-sha512."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete TSIG — cloudflare.secondary-dns---tsig--delete-tsig

Delete TSIG.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tsig_id — Required $ref: "#/definitions/secondary-dns_identifier-2"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

TSIG Details — cloudflare.secondary-dns---tsig--tsig-details

Get TSIG.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tsig_id — Required $ref: "#/definitions/secondary-dns_identifier-2"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update TSIG — cloudflare.secondary-dns---tsig--update-tsig

Modify TSIG.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tsig_id — Required $ref: "#/definitions/secondary-dns_identifier-2"
path.account_id — Required $ref: "#/definitions/secondary-dns_account_identifier"
body — Required $ref: "#/definitions/secondary-dns_tsig"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "account_id": "01a7362d577a6c3019a474fd6f485823"
  },
  "body": {
    "id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "tsig.customer.cf.",
    "secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
    "algo": "hmac-sha512."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

View secret usage — cloudflare.secrets-store-quota

Lists the number of secrets used in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account stores — cloudflare.secrets-store-list

Lists all the stores in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
query object Optional additionalProperties: false
query.direction string Optional Direction to sort objects. enum: ["asc","desc"]; default: "desc"
query.page integer Optional Page number. minimum: 0; multipleOf: 1
query.per_page integer Optional Number of objects to return per page. minimum: 0; maximum: 100; multipleOf: 1
query.order string Optional Order stores by values in the given field. enum: ["name","created","modified"]; default: "created"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a store — cloudflare.secrets-store-create

Creates a store in the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
body — Required $ref: "#/definitions/secrets-store_createStoreObject"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "service_x_keys"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a store — cloudflare.secrets-store-delete-by-id

Deletes a single store. By default, a store that still contains secrets cannot be deleted and returns HTTP 409 (Conflict) with the "store_not_empty" error. Pass force=true to cascade-delete all secrets in the store. Empty stores are always deleted regardless of the force parameter.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
query object Optional additionalProperties: false
query.force boolean Optional When true, cascade-deletes all secrets in the store before deleting the store itself. Required when deleting a non-empty store. Without this parameter, attempting to delete a non-empty store returns 409. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a store by ID — cloudflare.secrets-store-get-store-by-id

Returns details of a single store.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete secrets — cloudflare.secrets-store-delete-bulk

Deletes one or more secrets.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
body — Required $ref: "#/definitions/secrets-store_deleteSecretsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "ids": [
      "3fd85f74b32742f1bff64a85009dda07"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List store secrets — cloudflare.secrets-store-secrets-list

Lists all store secrets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
query object Optional additionalProperties: false
query.direction string Optional Direction to sort objects. enum: ["asc","desc"]; default: "desc"
query.page integer Optional Page number. minimum: 0; multipleOf: 1
query.per_page integer Optional Number of objects to return per page. minimum: 0; maximum: 100; multipleOf: 1
query.search string Optional Search secrets using a filter string, filtering across name and comment.
query.order string Optional Order secrets by values in the given field. enum: ["name","comment","created","modified","status"]; default: "created"
query.scopes array Optional Only secrets with the given scopes will be returned.
query.scopes[] string Optional enum: ["workers","ai_gateway","dex","access","containers","websearch"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a secret — cloudflare.secrets-store-secret-create

Creates a secret in the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
body array Required
body[] — Optional $ref: "#/definitions/secrets-store_createSecretObject"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a secret — cloudflare.secrets-store-secret-delete-by-id

Deletes a single secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
path.secret_id string Required Secret identifier. maxLength: 32

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "secret_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a secret by ID — cloudflare.secrets-store-get-by-id

Returns details of a single secret.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
path.secret_id string Required Secret identifier. maxLength: 32

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "secret_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch a secret — cloudflare.secrets-store-patch-by-id

Updates a single secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
path.secret_id string Required Secret identifier. maxLength: 32
body — Required $ref: "#/definitions/secrets-store_patchSecretObject"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "secret_id": "3fd85f74b32742f1bff64a85009dda07"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Duplicate Secret — cloudflare.secrets-store-duplicate-by-id

Creates a duplicate of the secret, keeping the value.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account identifier. maxLength: 32
path.store_id string Required Store identifier. maxLength: 32
path.secret_id string Required Secret identifier. maxLength: 32
body — Required $ref: "#/definitions/secrets-store_duplicateSecretObject"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "985e105f4ecef8ad9ca31a8372d0c353",
    "store_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "secret_id": "3fd85f74b32742f1bff64a85009dda07"
  },
  "body": {
    "name": "MY_API_KEY"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Security Center Insights — cloudflare.get-security-center-insights

Lists all Security Center insights for the account, showing security findings and recommendations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"
query.page — Optional default: 1
query.page — Optional allOf[1]; $ref: "#/definitions/security-center_page"
query.per_page — Optional default: 25
query.per_page — Optional allOf[1]; $ref: "#/definitions/security-center_perPage"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Account Audit Log — cloudflare.get-security-center-account-audit-log

Lists audit log entries for all Security Center insights in the account, showing changes to insight status and classification.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.per_page integer Optional Number of results per page. default: 25; minimum: 1; maximum: 1000
query.cursor string Optional Opaque cursor for pagination. Use the cursor value from result_info of the previous response.
query.field_changed string Optional Filter by the field that was changed. enum: ["status","user_classification"]
query.changed_by string Optional Filter by the actor that made the change.
query.since string Optional Filter entries changed at or after this timestamp (RFC 3339). format: "date-time"
query.before string Optional Filter entries changed before this timestamp (RFC 3339). format: "date-time"
query.order string Optional Sort order for results. Use 'asc' for oldest first or 'desc' for newest first. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Security Center Insight Counts by Class — cloudflare.get-security-center-insight-counts-by-class

Retrieves Security Center insight counts aggregated by classification class.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves a Partner Security Center Insight Count — cloudflare.get-security-center-partner-insight-count

Retrieves the uncapped count of active, non-dismissed, unclassified RiskRecon insights for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
query object Required additionalProperties: false
query.source string Required enum: ["riskrecon"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "source": "riskrecon"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Recent Account Scans — cloudflare.get-security-center-account-scans

Returns the most recent on-demand scans for the account, up to a maximum of 5. Each scan includes its ID, start time, and current status. This includes both account-wide and zone-scoped scans. Also returns quota information showing how many scans have been used and how many remain in the current 24-hour window.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start On-Demand Account Scan — cloudflare.start-security-center-account-scan

Initiates an on-demand security scan for the entire account, scanning all zones associated with the account. Rate limited to 5 scans per account per 24-hour window.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
body — Required $ref: "#/definitions/security-center_newScanRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "issue_type": "compliance_violation"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Security Center Insight Counts by Severity — cloudflare.get-security-center-insight-counts-by-severity

Retrieves Security Center insight counts aggregated by severity level (critical, high, medium, low).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Security Center Insight Counts by Type — cloudflare.get-security-center-insight-counts-by-type

Retrieves Security Center insight counts aggregated by insight type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Issue Audit Log — cloudflare.get-security-center-issue-audit-log

Lists audit log entries for a specific Security Center insight, showing changes to its status and classification over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.issue_id string Required
query object Optional additionalProperties: false
query.per_page integer Optional Number of results per page. default: 25; minimum: 1; maximum: 1000
query.cursor string Optional Opaque cursor for pagination. Use the cursor value from result_info of the previous response.
query.field_changed string Optional Filter by the field that was changed. enum: ["status","user_classification"]
query.changed_by string Optional Filter by the actor that made the change.
query.since string Optional Filter entries changed at or after this timestamp (RFC 3339). format: "date-time"
query.before string Optional Filter entries changed before this timestamp (RFC 3339). format: "date-time"
query.order string Optional Sort order for results. Use 'asc' for oldest first or 'desc' for newest first. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "issue_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates Security Center Insight Classification — cloudflare.update-security-center-insight-classification

Updates the user classification for a Security Center insight. Valid values are 'false_positive' or 'accept_risk'. To reset, set classification to null. Cannot change directly between classification values - must reset to null first.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.issue_id string Required
body — Required $ref: "#/definitions/security-center_userClassificationUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "issue_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Security Center Insight Context — cloudflare.get-security-center-insight-context

Returns the full context payload for an insight. This endpoint is used for insights with large payloads that are not included inline in the list response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.issue_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "issue_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Archives Security Center Insight — cloudflare.archive-security-center-insight

Archives a Security Center insight for an account, removing it from the active insights list while preserving historical data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.issue_id string Required
body object Required
body.dismiss boolean Optional default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "issue_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Partner Integration Settings — cloudflare.get-security-center-partner-settings

Returns whether the account has enabled the selected partner integration and, if enabled, whether the account has been matched with the partner. An integration that has not been configured is returned as disabled.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.partner string Required The partner integration identifier. enum: ["riskrecon"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "partner": "riskrecon"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates Partner Integration Settings — cloudflare.update-security-center-partner-settings

Enables or disables the selected partner integration for the account. Enabling the integration for the first time also schedules an account scan for that partner.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.partner string Required The partner integration identifier. enum: ["riskrecon"]
body — Required $ref: "#/definitions/security-center_partnerSettings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "partner": "riskrecon"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lists Partner-Discovered Shadow Zones — cloudflare.get-security-center-partner-shadow-zones

Lists domains discovered by the selected partner that are not in the account. Baseline accounts receive the total count only; premium accounts receive paginated items and may request CSV output.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.partner string Required The partner integration identifier. enum: ["riskrecon"]
query object Optional additionalProperties: false
query.cursor string Optional Opaque cursor from the previous response's result_info.cursor. Omit for the first page.
query.per_page integer Optional Number of premium partner asset results per page. Values other than 1 must be a multiple of 5. default: 25; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "partner": "riskrecon"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lists Hosts in a Partner-Discovered Shadow Zone — cloudflare.get-security-center-partner-shadow-zone-hosts

Lists hosts discovered beneath a shadow-zone domain. This endpoint is available only to premium accounts and supports JSON and CSV output.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
path.partner string Required The partner integration identifier. enum: ["riskrecon"]
path.domain string Required The shadow-zone domain.
query object Optional additionalProperties: false
query.cursor string Optional Opaque cursor from the previous response's result_info.cursor. Omit for the first page.
query.per_page integer Optional Number of premium partner asset results per page. Values other than 1 must be a multiple of 5. default: 25; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "partner": "riskrecon",
    "domain": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Account State — cloudflare.get-security-center-account-state

Returns account-level Security Center state: whether scans are enabled for the account and whether the account was recently reactivated from a dormant state.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates Account State — cloudflare.update-security-center-account-state

Updates account-level Security Center state. Currently supports enabling or disabling scans for the account. Returns the account's state after the update.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/security-center_identifier"
body — Required $ref: "#/definitions/security-center_updateAccountStateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "scans_enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Image Resizing configurations for account — cloudflare.account-settings-list-transformations

Returns a list of Image Resizing configurations across all zones for the account. This endpoint is useful for retrieving the transformations (image_resizing) state for all zones belonging to an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Unique Transformations billing setting — cloudflare.account-settings-get-ut-billing-setting

Retrieves the Unique Transformations billing configuration for an account. When enabled, billing data is directed to the Transformations pipeline.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Unique Transformations billing setting — cloudflare.account-settings-change-ut-billing-setting

Updates the Unique Transformations billing configuration for an account. When enabled, billing data is directed to the Transformations pipeline. Note: setting the value to "off" is not permitted once enabled.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_ut_billing_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "on"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List account shares — cloudflare.shares-list

Lists all account shares.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
query object Optional additionalProperties: false
query.status — Optional Filter shares by status. $ref: "#/definitions/resource-sharing_share_status"
query.kind — Optional Filter shares by kind. $ref: "#/definitions/resource-sharing_share_kind"
query.target_type — Optional Filter shares by target_type. $ref: "#/definitions/resource-sharing_share_target_type"
query.resource_types array Optional Filter share resources by resource_types.
query.resource_types[] — Optional $ref: "#/definitions/resource-sharing_resource_type"
query.order string Optional Order shares by values in the given field. enum: ["name","created"]; default: "created"
query.direction string Optional Direction to sort objects. enum: ["asc","desc"]; default: "asc"
query.page integer Optional Page number. Defaults to 1 when omitted. default: 1; minimum: 1; multipleOf: 1
query.per_page integer Optional Number of objects to return per page. Defaults to 20 when omitted. default: 20; minimum: 1; maximum: 100; multipleOf: 1
query.include_resources boolean Optional Include resources in the response.
query.include_recipient_counts boolean Optional Include recipient counts in the response.
query.include_tags_from string Optional Include share tags in the response. api reads tags from the tag service; mirror reads a local, eventually consistent replica. If the tag lookup fails, the response omits tags. enum: ["api","mirror"]
query.tag array Optional Filter shares by tag. Each value is either key=value (matches shares whose tags contain that key/value pair) or key alone (matches shares that have any value for that key). May be repeated; multiple tag parameters are ANDed together. Maximum 20 tag parameters per request. maxItems: 20
query.tag[] string Optional maxLength: 1281

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a share creation — cloudflare.share-create

Creates a share that makes a resource available to specific accounts in the caller's organization, or to the whole organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
body — Required $ref: "#/definitions/resource-sharing_create_share_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "My Shared WAF Managed Rule"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a share deletion — cloudflare.share-delete

Deletion is not immediate, an updated share object with a new status will be returned.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account share by ID — cloudflare.shares-get-by-id

Fetches share by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
query object Optional additionalProperties: false
query.include_resources boolean Optional Include resources in the response.
query.include_recipient_counts boolean Optional Include recipient counts in the response.
query.include_tags_from string Optional Include share tags in the response. api reads tags from the tag service; mirror reads a local, eventually consistent replica. If the tag lookup fails, the response omits tags. enum: ["api","mirror"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a share update — cloudflare.share-update

Updates the share's display name and tags. Omitting tags leaves the existing tags unchanged. Recipients and resources are managed via their subresource endpoints.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
body — Required $ref: "#/definitions/resource-sharing_update_share_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  },
  "body": {
    "name": "My Shared WAF Managed Rule"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List share excluded recipients by share ID — cloudflare.share-excluded-recipients-list

Lists the accounts excluded from an organization-targeted share. Returns an empty list for account-targeted shares.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
query object Optional additionalProperties: false
query.page integer Optional Page number. Defaults to 1 when omitted. default: 1; minimum: 1; multipleOf: 1
query.per_page integer Optional Number of objects to return per page. Defaults to 20 when omitted. default: 20; minimum: 1; maximum: 100; multipleOf: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger an account exclusion from a share — cloudflare.share-excluded-recipient-create

Excludes a single account from an organization-targeted share. The share continues to target the entire organization, but the excluded account is skipped during reconciliation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
body — Required $ref: "#/definitions/resource-sharing_create_share_excluded_recipient_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  },
  "body": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger excluded-account reconciliation on a share — cloudflare.share-excluded-recipients-update

Reconciles a share's excluded recipients to match the given list. Only valid for shares with target_type=organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
body — Required $ref: "#/definitions/resource-sharing_update_share_excluded_recipients_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger an account un-exclusion from a share — cloudflare.share-excluded-recipient-delete

Removes a single account from a share's excluded-recipient list. The account becomes eligible to receive the share again on the next reconciliation cycle.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
path.excluded_recipient_id — Required $ref: "#/definitions/resource-sharing_excluded_recipient_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07",
    "excluded_recipient_id": "4ae96b85c43850f2c0a7b9101a0eeb18"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get share excluded recipient by ID — cloudflare.share-excluded-recipients-get-by-id

Gets a single excluded recipient of a share by its identifier tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
path.excluded_recipient_id — Required $ref: "#/definitions/resource-sharing_excluded_recipient_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07",
    "excluded_recipient_id": "4ae96b85c43850f2c0a7b9101a0eeb18"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List share recipients by share ID — cloudflare.share-recipients-list

List share recipients by share ID. Returns all recipients regardless of their association_status (associating, associated, disassociating, disassociated). Callers that want only "active" recipients must filter client-side on the association_status field.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
query object Optional additionalProperties: false
query.include_resources boolean Optional Include resources in the response.
query.page integer Optional Page number. Defaults to 1 when omitted. default: 1; minimum: 1; multipleOf: 1
query.per_page integer Optional Number of objects to return per page. Defaults to 20 when omitted. default: 20; minimum: 1; maximum: 100; multipleOf: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger recipient reconciliation on a share — cloudflare.share-recipients-update

Replaces the full recipient list for an account-targeted share. The server computes the diff between the current and desired recipients: new accounts are added, accounts no longer in the list are marked for disassociation, and unchanged accounts are left as-is.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
body — Required $ref: "#/definitions/resource-sharing_update_share_recipients_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a recipient removal from a share — cloudflare.share-recipient-delete

Performs a soft delete: sets the recipient's desired_association_status to disassociated, which signals the background reconciliation workflow (Temporal) to remove the shared resources from the recipient account. The recipient record remains in the database for audit purposes and is still returned by GET /accounts/{account_id}/shares/{share_id}/recipients with its updated status.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
path.recipient_id — Required $ref: "#/definitions/resource-sharing_recipient_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07",
    "recipient_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get share recipient by ID — cloudflare.share-recipients-get-by-id

Get share recipient by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
path.recipient_id — Required $ref: "#/definitions/resource-sharing_recipient_id"
query object Optional additionalProperties: false
query.include_resources boolean Optional Include resources in the response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07",
    "recipient_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List share resources by share ID — cloudflare.share-resources-list

List share resources by share ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
query object Optional additionalProperties: false
query.status — Optional Filter share resources by status. $ref: "#/definitions/resource-sharing_resource_status"
query.resource_type — Optional Filter share resources by resource_type. $ref: "#/definitions/resource-sharing_resource_type"
query.page integer Optional Page number. Defaults to 1 when omitted. default: 1; minimum: 1; multipleOf: 1
query.per_page integer Optional Number of objects to return per page. Defaults to 20 when omitted. default: 20; minimum: 1; maximum: 100; multipleOf: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a resource addition to a share — cloudflare.share-resource-create

Adds a resource to an existing share, making it available to share recipients.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
body — Required $ref: "#/definitions/resource-sharing_create_share_resource_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07"
  },
  "body": {
    "resource_id": "0a679032-bbb2-4b7e-9acc-dd5c5cb27a17",
    "resource_type": "custom-ruleset",
    "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "meta": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a resource deletion from a share — cloudflare.share-resource-delete

Deletion is not immediate, an updated share resource object with a new status will be returned.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
path.share_resource_id — Required $ref: "#/definitions/resource-sharing_resource_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07",
    "share_resource_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get share resource by ID — cloudflare.share-resources-get-by-id

Get share resource by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
path.share_resource_id — Required $ref: "#/definitions/resource-sharing_resource_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07",
    "share_resource_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a resource metadata update in a share — cloudflare.share-resource-update

Updates the resource's meta. Only resources with status=active can be updated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-sharing_account_id"
path.share_id — Required $ref: "#/definitions/resource-sharing_share_id"
path.share_resource_id — Required $ref: "#/definitions/resource-sharing_resource_id"
body — Required $ref: "#/definitions/resource-sharing_update_share_resource_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "share_id": "3fd85f74b32742f1bff64a85009dda07",
    "share_resource_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "meta": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List jobs — cloudflare.slurper-list-jobs

Lists all R2 Super Slurper migration jobs for the account with their status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.limit integer Optional maximum: 50
query.offset integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a job — cloudflare.slurper-create-job

Creates a new R2 Super Slurper migration job to transfer objects from a source bucket (e.g. S3, GCS, R2) to R2.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/r2-slurper_CreateJobRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Abort all jobs — cloudflare.slurper-abort-all-jobs

Cancels all running R2 Super Slurper migration jobs for the account. Any objects in the middle of a transfer will finish, but no new objects will start transferring.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a job — cloudflare.slurper-delete-job

Deletes a completed, aborted, or errored R2 Super Slurper migration job. Active jobs cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.job_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get job details — cloudflare.slurper-get-job

Retrieves detailed status and configuration for a specific R2 Super Slurper migration job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.job_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Abort a job — cloudflare.slurper-abort-job

Cancels a specific R2 Super Slurper migration job. Any objects in the middle of a transfer will finish, but no new objects will start transferring.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.job_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get job logs — cloudflare.slurper-get-job-logs

Gets log entries for an R2 Super Slurper migration job, showing migration status changes, errors, etc.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.job_id string Required
query object Optional additionalProperties: false
query.limit integer Optional maximum: 50
query.offset integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pause a job — cloudflare.slurper-pause-job

Pauses a running R2 Super Slurper migration job. The job can be resumed later to continue transferring.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.job_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get job progress — cloudflare.slurper-get-job-progress

Retrieves current progress metrics for an R2 Super Slurper migration job

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.job_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resume a job — cloudflare.slurper-resume-job

Resumes a paused R2 Super Slurper migration job, continuing the transfer from where it stopped.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.job_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check source connectivity — cloudflare.slurper-check-source-connectivity

Check whether tokens are valid against the source bucket

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/r2-slurper_SourceJobSchema"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "vendor": "s3",
    "bucket": "example",
    "secret": {
      "accessKeyId": "example",
      "secretAccessKey": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check target connectivity — cloudflare.slurper-check-target-connectivity

Check whether tokens are valid against the target bucket

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/r2-slurper_R2TargetSchema"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "vendor": "r2",
    "bucket": "example",
    "secret": {
      "accessKeyId": "example",
      "secretAccessKey": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all SSO connectors — cloudflare.get-all-sso-connectors

Lists all SSO connectors configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Initialize new SSO connector — cloudflare.init-new-sso-connector

Creates a new SSO connector for logging into Cloudflare through an identity provider.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body object Optional
body.begin_verification boolean Optional Begin the verification process after creation default: true
body.email_domain string Required Email domain of the new SSO connector
body.use_fedramp_language — Optional $ref: "#/definitions/iam_use_fedramp_language"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete SSO connector — cloudflare.delete-sso-connector

Deletes an SSO connector from the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.sso_connector_id — Required $ref: "#/definitions/iam_sso_connector_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sso_connector_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get single SSO connector — cloudflare.get-sso-connector

Retrieves details for a specific SSO connector.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.sso_connector_id — Required $ref: "#/definitions/iam_sso_connector_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sso_connector_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update SSO connector state — cloudflare.update-sso-connector-state

Updates the state or configuration of an SSO connector.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.sso_connector_id — Required $ref: "#/definitions/iam_sso_connector_identifier"
body object Optional
body.enabled boolean Optional SSO Connector enabled state
body.use_fedramp_language — Optional $ref: "#/definitions/iam_use_fedramp_language"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sso_connector_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Begin SSO connector verification — cloudflare.begin-sso-connector-verification

Validates the user has added the DNS TXT record required for validating ownership of the domain they are trying to set up a connector for.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.sso_connector_id — Required $ref: "#/definitions/iam_sso_connector_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sso_connector_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List namespaces — cloudflare.workers-kv-namespace-list-namespaces

Lists Workers KV namespaces owned by the specified account. Use page and per_page to select a page of results, and order and direction to control sorting.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 1; maximum: 1000
query.order string Optional Namespace field to sort by (id or title). enum: ["id","title"]
query.direction string Optional Sort namespaces in ascending (asc) or descending (desc) order. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a namespace — cloudflare.workers-kv-namespace-create-a-namespace

Creates a Workers KV namespace in the specified account with the given title. Returns 400 if the account already owns a namespace with that title; an existing namespace must be explicitly deleted before it can be replaced. An optional jurisdiction restricts where data is durably stored and can only be set at creation time.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"
body — Required $ref: "#/definitions/workers-kv_create_namespace_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "title": "My Own Namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a namespace — cloudflare.workers-kv-namespace-remove-a-namespace

Deletes the specified Workers KV namespace and its stored key-value pairs from the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a namespace — cloudflare.workers-kv-namespace-get-a-namespace

Returns the Workers KV namespace for the specified account and namespace ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rename a namespace — cloudflare.workers-kv-namespace-rename-a-namespace

Changes the title of the specified Workers KV namespace and returns the updated namespace. The namespace ID and stored key-value pairs are unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"
body — Required $ref: "#/definitions/workers-kv_create_rename_namespace_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "title": "My Own Namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Write multiple key-value pairs — cloudflare.workers-kv-namespace-write-multiple-key-value-pairs

Writes up to 10,000 key-value pairs to the specified Workers KV namespace from a JSON array, with optional metadata and expiration settings for each pair. Existing values and expirations are overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will not expire. If both are set, expiration_ttl takes precedence. The entire request must be 100 megabytes or less. The result reports the number of successful writes and any keys that failed and should be retried.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"
body — Required $ref: "#/definitions/workers-kv_bulk_write"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete multiple key-value pairs — cloudflare.workers-kv-namespace-delete-multiple-key-value-pairs

Deletes up to 10,000 key-value pairs from the specified Workers KV namespace. Send a JSON array of the key names to delete. The result reports the number of successful deletions and any keys that failed and should be retried.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"
body — Required $ref: "#/definitions/workers-kv_bulk_delete"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get multiple key-value pairs — cloudflare.workers-kv-namespace-get-multiple-key-value-pairs

Retrieves the text-based values of up to 100 keys from the specified Workers KV namespace. The result maps each requested key to its value. Set type to json to parse JSON values instead of returning strings, and set withMetadata to true to include metadata with each value. Binary values are not supported by this operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"
body object Required
body.keys array Required Array of keys to retrieve (maximum of 100). maxItems: 100
body.keys[] — Optional $ref: "#/definitions/workers-kv_key_name_bulk"
body.type string Optional Return values as strings with text, or parse stored JSON values with json. enum: ["text","json"]; default: "text"
body.withMetadata boolean Optional Whether to include metadata in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "keys": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List keys in a namespace — cloudflare.workers-kv-namespace-list-a-namespace--s-keys

Lists key names in the specified Workers KV namespace, with expiration times and metadata when present. Use prefix to filter names and cursor to request the next page. Values are not included.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"
query object Optional additionalProperties: false
query.limit number Optional Maximum number of keys to return in one response. Pass result_info.cursor from the response as cursor to request the next page. default: 1000; minimum: 10; maximum: 1000
query.prefix string Optional Filters returned keys by a name prefix. Exact matches and any key names that begin with the prefix will be returned.
query.cursor string Optional Opaque pagination token from result_info.cursor in the previous response. Pass it unchanged to request the next page of keys.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a key's metadata — cloudflare.workers-kv-namespace-read-the-metadata-for-a-key

Returns the JSON metadata associated with the specified key in the Workers KV namespace, without retrieving its value. Use URL-encoding for special characters (for example, :, !, %) in the key name when constructing the request URL.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_name — Required $ref: "#/definitions/workers-kv_key_name"
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_name": "My-Key",
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a key-value pair — cloudflare.workers-kv-namespace-delete-key-value-pair

Deletes the specified key and its value from the Workers KV namespace. Use URL-encoding for special characters (for example, :, !, %) in the key name when constructing the request URL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_name — Required $ref: "#/definitions/workers-kv_key_name"
path.namespace_id — Required $ref: "#/definitions/workers-kv_namespace_identifier"
path.account_id — Required $ref: "#/definitions/workers-kv_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_name": "My-Key",
    "namespace_id": "0f2ac74b498b48028cb68387c421e279",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List videos — cloudflare.stream-videos-list-videos

Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
query object Optional additionalProperties: false
query.status — Optional $ref: "#/definitions/stream_media_state"
query.creator — Optional $ref: "#/definitions/stream_creator"
query.type — Optional $ref: "#/definitions/stream_type"
query.asc — Optional $ref: "#/definitions/stream_asc"
query.video_name — Optional $ref: "#/definitions/stream_video_name"
query.search — Optional $ref: "#/definitions/stream_search"
query.start — Optional $ref: "#/definitions/stream_start"
query.end — Optional $ref: "#/definitions/stream_end"
query.include_counts — Optional $ref: "#/definitions/stream_include_counts"
query.id string Optional Filter by video ID(s). Can be a single ID or a comma-separated list of IDs.
query.name string Optional Filter by video name/UID(s). Can be a single name or a comma-separated list.
query.live_input_id string Optional Filter by live input ID to find videos associated with a specific live stream.
query.before string Optional Alias for 'end'. Returns videos created before this date/time (RFC 3339 format). format: "date-time"
query.after string Optional Alias for 'start'. Returns videos created after this date/time (RFC 3339 format). format: "date-time"
query.limit integer Optional Maximum number of videos to return (default 1000, max 1000). minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Initiate video uploads using TUS — cloudflare.stream-videos-initiate-video-uploads-using-tus

Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a location header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Required additionalProperties: false
headers.Tus-Resumable — Required $ref: "#/definitions/stream_tus_resumable"
headers.Upload-Creator — Optional $ref: "#/definitions/stream_creator"
headers.Upload-Length — Required $ref: "#/definitions/stream_upload_length"
headers.Upload-Metadata — Optional $ref: "#/definitions/stream_upload_metadata"
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
query object Optional additionalProperties: false
query.direct_user — Optional $ref: "#/definitions/stream_direct_user"

Full JSON Schema

Full JSON Schema

Example input

{
  "headers": {
    "Tus-Resumable": "1.0.0",
    "Upload-Length": 1
  },
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Clip videos given a start and end time — cloudflare.stream-video-clipping-clip-videos-given-a-start-and-end-time

Clips a video based on the specified start and end times provided in seconds.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
body — Required $ref: "#/definitions/stream_videoClipStandard"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "clippedFromVideoUID": "023e105f4ecef8ad9ca31a8372d0c353",
    "startTimeSeconds": 1,
    "endTimeSeconds": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload videos from a URL — cloudflare.stream-videos-upload-videos-from-a-url

Uploads a video to Stream from a provided URL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
headers object Optional additionalProperties: false
headers.Upload-Creator — Optional $ref: "#/definitions/stream_creator"
body — Required $ref: "#/definitions/stream_video_copy_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "input": "https://example.com/myvideo.mp4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload videos via direct upload URLs — cloudflare.stream-videos-upload-videos-via-direct-upload-ur-ls

Creates a direct upload endpoint that allows an end-user to upload a video without an API key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
headers object Optional additionalProperties: false
headers.Upload-Creator — Optional $ref: "#/definitions/stream_creator"
body — Required $ref: "#/definitions/stream_direct_upload_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "maxDurationSeconds": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List signing keys — cloudflare.stream-signing-keys-list-signing-keys

Lists the video ID and creation date and time when a signing key was created.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create signing keys — cloudflare.stream-signing-keys-create-signing-keys

Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete signing keys — cloudflare.stream-signing-keys-delete-signing-keys

Deletes signing keys and revokes all signed URLs generated with the key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier-2"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List live inputs — cloudflare.stream-live-inputs-list-live-inputs

Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_identifier-2"
query object Optional additionalProperties: false
query.include_counts — Optional $ref: "#/definitions/stream_include_counts"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a live input — cloudflare.stream-live-inputs-create-a-live-input

Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_identifier-2"
headers object Optional additionalProperties: false
headers.Idempotency-Key string Optional Prevents duplicate live inputs from being created when retrying this request. The key is scoped to the account, may contain up to 255 bytes, and expires six hours after the live input is created. Reusing a key for a deleted input before expiry returns a 409 Conflict response. maxLength: 255
body — Required $ref: "#/definitions/stream_create_input_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a live input — cloudflare.stream-live-inputs-delete-a-live-input

Permanently delete a live input, making it inaccessible and blocking current and future broadcasts to it. Existing recordings will be retained.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a live input — cloudflare.stream-live-inputs-retrieve-a-live-input

Retrieves details of an existing live input.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a live input — cloudflare.stream-live-inputs-update-a-live-input

Updates a specified live input.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"
body — Required $ref: "#/definitions/stream_update_input_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable a live input — cloudflare.stream-live-inputs-disable-a-live-input

Prevents a live input from being streamed to and terminates any active broadcasts until re-enabled.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable a live input — cloudflare.stream-live-inputs-enable-a-live-input

Allows a disabled live input to start receiving broadcasts again.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all outputs associated with a specified live input — cloudflare.stream-live-inputs-list-all-outputs-associated-with-a-spec-7c0ac43140

Retrieves all outputs associated with a specified live input.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new output, connected to a live input — cloudflare.stream-live-inputs-create-a-new-output--connected-to-a-live-input

Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"
body — Required $ref: "#/definitions/stream_create_output_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "url": "rtmp://a.rtmp.youtube.com/live2",
    "streamKey": "uzya-f19y-g2g9-a2ee-51j2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an output — cloudflare.stream-live-inputs-delete-an-output

Deletes an output and removes it from the associated live input.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.output_identifier — Required $ref: "#/definitions/stream_output_identifier"
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "output_identifier": "baea4d9c515887b80289d5c33cf01145",
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an output — cloudflare.stream-live-inputs-update-an-output

Updates the state of an output.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.output_identifier — Required $ref: "#/definitions/stream_output_identifier"
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"
body — Required $ref: "#/definitions/stream_update_output_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "output_identifier": "baea4d9c515887b80289d5c33cf01145",
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rotate keys for a live input — cloudflare.stream-live-inputs-rotate-keys-for-a-live-input

Rotates the credentials for a live input without changing its identifier. Old credentials are revoked, broadcasts using stale credentials are automatically disconnected shortly after rotation, and the response returns refreshed credentials.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.live_input_identifier — Required $ref: "#/definitions/stream_live_input_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "live_input_identifier": "66be4bf738797e01e1fca35a7bdecdcd",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Storage use — cloudflare.stream-videos-storage-usage

Returns information about an account's storage use.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
query object Optional additionalProperties: false
query.creator — Optional $ref: "#/definitions/stream_creator"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account Stream usage — cloudflare.usage-analytics-get-account-stream-usage

Retrieve Stream usage analytics for an account. Returns time-series data for Stream billable minutes viewed across all zones in the account. The gateway rewrites this path before forwarding to the backend usage handler.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Standard Cloudflare hex account identifier. The API gateway translates this to an internal numeric ID before forwarding to the backend service. $ref: "#/definitions/usage-analytics_identifier"
query object Optional additionalProperties: false
query.metrics string Optional Comma-separated list of metrics to include in the response. Available metrics depend on the endpoint. Billing usage supports: streamMinutesViewed, rateLimitingRequestsAllowed, loadBalancingQueries, argoAcceleratedBytes, workersRequests, workersKVReads, imageResizingRequests, spectrumBytesTransferred, mediaUniqueTransformations. Stream/media usage supports: streamMinutesViewed.
query.since string Optional Start of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to 6 hours before the current time. format: "date-time"
query.until string Optional End of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to the current time. format: "date-time"
query.time_delta string Optional Time unit to aggregate usage observations into. Data retention is approximately 18 months. The effective number of data points returned depends on the time range and granularity selected. For example, requesting hourly granularity over 18 months could produce up to ~13,000 data points; use the limit parameter to cap results and be aware that responses may be truncated. enum: ["hour","day","week","month","quarter","year"]; default: "hour"
query.limit integer Optional Maximum number of data points to return. The actual number of results depends on the interaction between the time range (since/until) and time_delta granularity. Results are truncated to this limit without error if the time range produces more data points than the limit allows. default: 100; minimum: 1; maximum: 10000
query.filters string Optional Filter expressions to apply to the query. Format: field==value. Multiple filters can be combined.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List watermark profiles — cloudflare.stream-watermark-profile-list-watermark-profiles

Lists all watermark profiles for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create watermark profiles via basic upload — cloudflare.stream-watermark-profile-create-watermark-profiles-via-basic-upload

Creates watermark profiles using a single HTTP POST multipart/form-data request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
body object Required
body.name — Optional $ref: "#/definitions/stream_name"
body.opacity — Optional $ref: "#/definitions/stream_opacity"
body.padding — Optional $ref: "#/definitions/stream_padding"
body.position — Optional $ref: "#/definitions/stream_position"
body.scale — Optional $ref: "#/definitions/stream_scale"
body.url string Optional URL of the watermark image to copy. format: "uri"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete watermark profiles — cloudflare.stream-watermark-profile-delete-watermark-profiles

Deletes a watermark profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_watermark_identifier"
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Watermark profile details — cloudflare.stream-watermark-profile-watermark-profile-details

Retrieves details for a single watermark profile.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_watermark_identifier"
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete webhooks — cloudflare.stream-webhook-delete-webhooks

Deletes the on-demand video webhook.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

View webhook — cloudflare.stream-webhook-view-webhooks

Retrieve current on-demand webhook information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create VOD webhooks — cloudflare.stream-webhook-create-webhooks

Create a webhook for notifications about on-demand video uploads.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
body — Required $ref: "#/definitions/stream_webhook_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "notificationUrl": "https://example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete video — cloudflare.stream-videos-delete-video

Deletes a video and its copies from Cloudflare Stream.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve video details — cloudflare.stream-videos-retrieve-video-details

Fetches details for a single video.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit video details — cloudflare.stream-videos-update-video-details

Edit details for a single video.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
body — Required $ref: "#/definitions/stream_video_update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List additional audio tracks on a video — cloudflare.list-audio-tracks

Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
path.identifier — Required $ref: "#/definitions/stream_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "identifier": "ea95132c15732412d22c1476fa83f27a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add audio tracks to a video — cloudflare.add-audio-track

Adds an additional audio track to a video using the provided audio track URL.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
path.identifier — Required $ref: "#/definitions/stream_identifier"
body — Required $ref: "#/definitions/stream_copyAudioTrack"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "identifier": "ea95132c15732412d22c1476fa83f27a"
  },
  "body": {
    "label": "director commentary"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete additional audio tracks on a video — cloudflare.delete-audio-tracks

Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.audio_identifier — Required $ref: "#/definitions/stream_audio_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "audio_identifier": "ea95132c15732412d22c1476fa83f27a"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit additional audio tracks on a video — cloudflare.edit-audio-tracks

Edits additional audio tracks on a video. Editing the default status of an audio track to true will mark all other audio tracks on the video default status to false.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.audio_identifier — Required $ref: "#/definitions/stream_audio_identifier"
body — Required $ref: "#/definitions/stream_editAudioTrack"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "audio_identifier": "ea95132c15732412d22c1476fa83f27a"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List captions or subtitles — cloudflare.stream-subtitles.-captions-list-captions-or-subtitles

Lists the available captions or subtitles for a specific video.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete captions or subtitles — cloudflare.stream-subtitles.-captions-delete-captions-or-subtitles

Removes the captions or subtitles from a video.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.language — Required $ref: "#/definitions/stream_language"
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "language": "tr",
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List captions or subtitles for a provided language — cloudflare.stream-subtitles.-captions-get-caption-or-subtitle-for-language

Lists the captions or subtitles for provided language.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.language — Required $ref: "#/definitions/stream_language"
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "language": "tr",
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Generate captions or subtitles for a provided language via AI — cloudflare.stream-subtitles.-captions-generate-caption-or-subtitle-for-language

Generate captions or subtitles for provided language via AI.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.language — Required $ref: "#/definitions/stream_language"
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "language": "tr",
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Return WebVTT captions for a provided language — cloudflare.stream-subtitles.-captions-get-vtt-caption-or-subtitle

Return WebVTT captions for a provided language.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.language — Required $ref: "#/definitions/stream_language"
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "language": "tr",
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete downloads — cloudflare.stream-mp4-downloads-delete-downloads

Delete the downloads for a video. Use /downloads/{download_type} instead for type-specific downloads. Available types are default and audio.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List downloads — cloudflare.stream-mp4-downloads-list-downloads

Lists the downloads created for a video.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create downloads — cloudflare.stream-mp4-downloads-create-downloads

Creates a download for a video when a video is ready to view. Use /downloads/{download_type} instead for type-specific downloads. Available types are default and audio.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete download — cloudflare.stream-downloads-delete-type-specific-downloads

Delete specific type of download. For backwards-compatibility, DELETE requests to /downloads will delete the default download.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"
path.download_type — Required $ref: "#/definitions/stream_download_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "download_type": "audio"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create download — cloudflare.stream-downloads-create-type-specific-downloads

Creates a download for a video of specified type. For backwards-compatibility, POST requests to /downloads will enable the default download.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_identifier-2"
path.download_type — Required $ref: "#/definitions/stream_download_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "download_type": "audio"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deprecated: Retrieve legacy embed code HTML — cloudflare.stream-videos-retreieve-embed-code-html

Fetches the legacy HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create signed URL tokens for videos — cloudflare.stream-videos-create-signed-url-tokens-for-videos

Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/stream_identifier"
path.account_id — Required $ref: "#/definitions/stream_account_identifier"
body — Required $ref: "#/definitions/stream_signed_token_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ea95132c15732412d22c1476fa83f27a",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Subscriptions — cloudflare.account-subscriptions-list-subscriptions

Lists all of an account's subscriptions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Subscription — cloudflare.account-subscriptions-create-subscription

Creates an account subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel Delayed Downgrade — cloudflare.account-subscriptions-cancel-delayed-downgrade

Cancels pending delayed downgrades for the specified subscriptions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body object Required
body.subscription_ids array Optional List of subscription identifiers to cancel downgrades for.
body.subscription_ids[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Subscription — cloudflare.account-subscriptions-delete-subscription

Deletes an account's subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subscription_identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subscription_identifier": "506e3185e9c882d175a2d0cb0093d9f2",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Subscription — cloudflare.account-subscriptions-get-subscription

Gets an account subscription by identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subscription_identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subscription_identifier": "506e3185e9c882d175a2d0cb0093d9f2",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Subscription — cloudflare.account-subscriptions-update-subscription

Updates an account subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subscription_identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subscription_identifier": "506e3185e9c882d175a2d0cb0093d9f2",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Append Subscription Action — cloudflare.account-subscriptions-action-append-subscription

Smartly applies the incoming subscription into the lifecycle of the subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subscription_identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subscription_identifier": "506e3185e9c882d175a2d0cb0093d9f2",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cancel Reason — cloudflare.account-subscriptions-get-cancel-reason

Gets the cancellation reason for an account subscription.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subscription_identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subscription_identifier": "506e3185e9c882d175a2d0cb0093d9f2",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Cancel Reason — cloudflare.account-subscriptions-create-cancel-reason

Records a cancellation reason for an account subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subscription_identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"
path.account_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_cancel_reason_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subscription_identifier": "506e3185e9c882d175a2d0cb0093d9f2",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete tags from an account-level resource — cloudflare.tags-delete

Removes all tags from a specific account-level resource.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-tagging_account_id"
headers object Optional additionalProperties: false
headers.If-Match string Optional ETag value for optimistic concurrency control. When provided, the server will verify the current resource ETag matches before applying the write. Returns 412 Precondition Failed if the resource has been modified since the ETag was obtained. Omit this header for unconditional writes.
body — Required $ref: "#/definitions/resource-tagging_delete_tags_request_account_level"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "resource_type": "worker_version",
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "3f72a691-44b3-4c11-8642-c18a88ddaa5e"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get tags for an account-level resource — cloudflare.tags-get

Retrieves tags for a specific account-level resource.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-tagging_account_id"
query object Required additionalProperties: false
query.resource_id — Required The ID of the resource to retrieve tags for. $ref: "#/definitions/resource-tagging_resource_id"
query.resource_type — Required The type of the resource. $ref: "#/definitions/resource-tagging_account_resource_type"
query.worker_id — Optional Worker identifier. Required for worker_version resources. $ref: "#/definitions/resource-tagging_worker_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_type": "worker"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set tags for an account-level resource — cloudflare.tags-set

Creates or updates tags for a specific account-level resource. Replaces all existing tags for the resource.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-tagging_account_id"
headers object Optional additionalProperties: false
headers.If-Match string Optional ETag value for optimistic concurrency control. When provided, the server will verify the current resource ETag matches before applying the write. Returns 412 Precondition Failed if the resource has been modified since the ETag was obtained. Omit this header for unconditional writes.
body — Required $ref: "#/definitions/resource-tagging_set_tags_request_account_level"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "resource_type": "worker_version",
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "3f72a691-44b3-4c11-8642-c18a88ddaa5e"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tag keys — cloudflare.tags-list-keys

Lists all distinct tag keys used across resources in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-tagging_account_id"
query object Optional additionalProperties: false
query.cursor string Optional Cursor for pagination.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tagged resources — cloudflare.tags-list

Lists all tagged resources for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.include_navigation boolean Optional Resolve current namespace Worker navigation by immutable child tag. Optional read-only navigation is omitted for deleted or unresolved children. Lookups are limited to this page, at most five concurrently, with a shared two-second budget. Tag identity, ETag, filters and pagination are unchanged; name filtering still uses the stored resource name. Defaults to false. default: false
query.type array Optional Filter by resource type. Can be repeated to filter by multiple types (OR logic). Example: ?type=zone&type=worker
query.type[] — Optional $ref: "#/definitions/resource-tagging_resource_type"
query.name string Optional Filter by resource name. Performs a case-insensitive substring match. Example: ?name=my-zone maxLength: 256
query.id array Optional Filter by resource ID. Can be repeated up to 50 times to filter by multiple IDs. Example: ?id=abc&id=def maxItems: 50
query.id[] — Optional $ref: "#/definitions/resource-tagging_resource_id"
query.case_insensitive boolean Optional Match tag keys and values case-insensitively. Stored casing is unchanged. Example: ?tag=environment=production&case_insensitive=true default: false
query.tag array Optional Filter resources by tag criteria. This parameter can be repeated multiple times, with AND logic between parameters. Supported syntax: - Key-only: tag=&lt;key&gt; - Resource must have the tag key (e.g., tag=production) - Key-value: tag=&lt;key&gt;=&lt;value&gt; - Resource must have the tag with specific value (e.g., tag=env=prod) - Multiple values (OR): tag=&lt;key&gt;=&lt;v1&gt;,&lt;v2&gt; - Resource must have tag with any of the values (e.g., tag=env=prod,staging) - Negate key-only: tag=!&lt;key&gt; - Resource must not have the tag key (e.g., tag=!archived) - Negate key-value: tag=&lt;key&gt;!=&lt;value&gt; - Resource must not have the tag with specific value (e.g., tag=region!=us-west-1) Multiple tag parameters are combined with AND logic.
query.tag[] string Optional
query.cursor string Optional Cursor for pagination.
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-tagging_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tag key summary — cloudflare.tags-list-key-summary

Lists all distinct tag keys and their distinct values across resources in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-tagging_account_id"
query object Optional additionalProperties: false
query.cursor string Optional Cursor for pagination.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tag values — cloudflare.tags-list-values

Lists all distinct values for a given tag key, optionally filtered by resource type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/resource-tagging_account_id"
path.tag_key string Required The tag key to retrieve values for.
query object Optional additionalProperties: false
query.type — Optional Filter by resource type. $ref: "#/definitions/resource-tagging_resource_type"
query.cursor string Optional Cursor for pagination.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tag_key": "environment"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tunnel routes — cloudflare.tunnel-route-list-tunnel-routes

Lists and filters private network routes in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.comment — Optional $ref: "#/definitions/tunnel_route_comment"
query.is_deleted boolean Optional If true, only include deleted routes. If false, exclude deleted routes. If empty, all routes will be included.
query.network_subset — Optional If set, only list routes that are contained within this IP range.
query.network_subset — Optional allOf[1]; $ref: "#/definitions/tunnel_ip_network"
query.network_superset — Optional If set, only list routes that contain this IP range.
query.network_superset — Optional allOf[1]; $ref: "#/definitions/tunnel_ip_network"
query.existed_at — Optional $ref: "#/definitions/tunnel_existed_at"
query.tunnel_id — Optional $ref: "#/definitions/tunnel_tunnel_id"
query.route_id — Optional $ref: "#/definitions/tunnel_route_id"
query.tun_types — Optional $ref: "#/definitions/tunnel_tunnel_types"
query.virtual_network_id — Optional $ref: "#/definitions/tunnel_virtual_network_id"
query.per_page — Optional $ref: "#/definitions/tunnel_per_page"
query.page — Optional $ref: "#/definitions/tunnel_page_number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a tunnel route — cloudflare.tunnel-route-create-a-tunnel-route

Routes a private network through a Cloudflare Tunnel.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_route_comment"
body.network — Required $ref: "#/definitions/tunnel_ip_network"
body.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
body.virtual_network_id — Optional $ref: "#/definitions/tunnel_virtual_network_id_computed_optional"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "network": "172.16.0.0/16",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get tunnel route by IP — cloudflare.tunnel-route-get-tunnel-route-by-ip

Fetches routes that contain the given IP address.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip — Required $ref: "#/definitions/tunnel_ip"
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.virtual_network_id — Optional $ref: "#/definitions/tunnel_virtual_network_id"
query.default_virtual_network_fallback boolean Optional When the virtual_network_id parameter is not provided the request filter will default search routes that are in the default virtual network for the account. If this parameter is set to false, the search will include routes that do not have a virtual network. default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip": "10.1.0.137",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a tunnel route — cloudflare.tunnel-route-delete-a-tunnel-route

Deletes a private network route from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/tunnel_route_id"
path.account_id — Required $ref: "#/definitions/tunnel_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get tunnel route — cloudflare.tunnel-route-get-tunnel-route

Get a private network route in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.route_id — Required $ref: "#/definitions/tunnel_route_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "route_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a tunnel route — cloudflare.tunnel-route-update-a-tunnel-route

Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/tunnel_route_id"
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_route_comment"
body.network — Optional $ref: "#/definitions/tunnel_ip_network"
body.tunnel_id — Optional $ref: "#/definitions/tunnel_tunnel_id"
body.virtual_network_id — Optional $ref: "#/definitions/tunnel_virtual_network_id_computed_optional"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List virtual networks — cloudflare.tunnel-virtual-network-list-virtual-networks

Lists and filters virtual networks in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.id — Optional $ref: "#/definitions/tunnel_virtual_network_id"
query.name — Optional $ref: "#/definitions/tunnel_virtual_network_name"
query.is_default boolean Optional If true, only include the default virtual network. If false, exclude the default virtual network. If empty, all virtual networks will be included.
query.is_default_network boolean Optional If true, only include the default virtual network. If false, exclude the default virtual network. If empty, all virtual networks will be included.
query.is_deleted boolean Optional If true, only include deleted virtual networks. If false, exclude deleted virtual networks. If empty, all virtual networks will be included.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a virtual network — cloudflare.tunnel-virtual-network-create-a-virtual-network

Adds a new virtual network to an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_virtual_network_comment"
body.is_default boolean Optional If true, this virtual network is the default for the account.
body.is_default_network — Optional $ref: "#/definitions/tunnel_is_default_network_optional"
body.name — Required $ref: "#/definitions/tunnel_virtual_network_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "us-east-1-vpc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a virtual network — cloudflare.tunnel-virtual-network-delete

Deletes an existing virtual network.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.virtual_network_id — Required $ref: "#/definitions/tunnel_virtual_network_id"
path.account_id — Required $ref: "#/definitions/tunnel_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "virtual_network_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a virtual network — cloudflare.tunnel-virtual-network-get

Get a virtual network.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.virtual_network_id — Required $ref: "#/definitions/tunnel_virtual_network_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "virtual_network_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a virtual network — cloudflare.tunnel-virtual-network-update

Updates an existing virtual network.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.virtual_network_id — Required $ref: "#/definitions/tunnel_virtual_network_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_virtual_network_comment"
body.is_default_network — Optional $ref: "#/definitions/tunnel_is_default_network_optional"
body.name — Optional $ref: "#/definitions/tunnel_virtual_network_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "virtual_network_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Tokens — cloudflare.account-api-tokens-list-tokens

List Account Owned API tokens created for this account. Callers with com.cloudflare.api.account.token.list_self permission only receive tokens they created. Results include active, disabled, and recently-expired tokens when include_expired is set to true.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.include_expired boolean Optional When true, includes recently-expired tokens in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Token — cloudflare.account-api-tokens-create-token

Create a new Account Owned API token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
body — Required $ref: "#/definitions/iam_create_payload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "readonly token",
    "policies": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Permission Groups — cloudflare.account-api-tokens-list-permission-groups

Find all available permission groups for Account Owned API Tokens. Each permission group indicates whether the caller can select it when creating a token. Token creation performs the authoritative permission check.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
query object Optional additionalProperties: false
query.name string Optional Filter by the name of the permission group. The value must be URL-encoded.
query.scope string Optional Filter by the scope of the permission group. The value must be URL-encoded.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Verify Token — cloudflare.account-api-tokens-verify-token

Test whether a token works.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Token — cloudflare.account-api-tokens-delete-token

Destroy an Account Owned API token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.token_id — Required $ref: "#/definitions/iam_token_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "token_id": "ed17574386854bf78a67040be0a770b0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Token Details — cloudflare.account-api-tokens-token-details

Get information about a specific Account Owned API token.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.token_id — Required $ref: "#/definitions/iam_token_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "token_id": "ed17574386854bf78a67040be0a770b0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Roll Token — cloudflare.account-api-tokens-roll-token

Roll the Account Owned API token secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/iam_account_identifier"
path.token_id — Required $ref: "#/definitions/iam_token_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "token_id": "ed17574386854bf78a67040be0a770b0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete script triggers — cloudflare.wor-delete-script-triggers

Deletes all event trigger declarations owned by a Worker script.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.script_name string Required minLength: 1; maxLength: 255
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "script_name": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get script triggers — cloudflare.wor-get-script-triggers

Returns the event trigger declarations owned by a Worker script.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.script_name string Required minLength: 1; maxLength: 255
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "script_name": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add script triggers — cloudflare.wor-add-script-triggers

Adds event trigger declarations without removing existing declarations owned by the script.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.script_name string Required minLength: 1; maxLength: 255
path.account_id string Required
body array Required maxItems: 100
body[] object Optional
body[].filter object Optional default: {}; additionalProperties: {"anyOf":[{"maxLength":1024,"type":"string"},{"type":"number"},{"type":"boolean"}]}
body[].targets array Required minItems: 1; maxItems: 100
body[].targets[] object Optional
body[].targets[].script_name string Required minLength: 1; maxLength: 255
body[].targets[].type string Required enum: ["workflow"]
body[].targets[].workflow_name string Required minLength: 1; maxLength: 255
body[].type string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "script_name": "example",
    "account_id": "example"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace script triggers — cloudflare.wor-replace-script-triggers

Replaces all event trigger declarations owned by a Worker script.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.script_name string Required minLength: 1; maxLength: 255
path.account_id string Required
body array Required maxItems: 100
body[] object Optional
body[].filter object Optional default: {}; additionalProperties: {"anyOf":[{"maxLength":1024,"type":"string"},{"type":"number"},{"type":"boolean"}]}
body[].targets array Required minItems: 1; maxItems: 100
body[].targets[] object Optional
body[].targets[].script_name string Required minLength: 1; maxLength: 255
body[].targets[].type string Required enum: ["workflow"]
body[].targets[].workflow_name string Required minLength: 1; maxLength: 255
body[].type string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "script_name": "example",
    "account_id": "example"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List All Tunnels — cloudflare.cloudflare-tunnel-list-all-tunnels

Lists and filters all types of Tunnels in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.name string Optional A user-friendly name for the tunnel.
query.is_deleted boolean Optional If true, only include deleted tunnels. If false, exclude deleted tunnels. If empty, all tunnels will be included.
query.existed_at — Optional $ref: "#/definitions/tunnel_existed_at"
query.uuid — Optional $ref: "#/definitions/tunnel_tunnel_id"
query.was_active_at string Optional format: "date-time"
query.was_inactive_at string Optional format: "date-time"
query.include_prefix string Optional
query.exclude_prefix string Optional
query.tun_types — Optional $ref: "#/definitions/tunnel_tunnel_types"
query.status — Optional $ref: "#/definitions/tunnel_status"
query.per_page — Optional $ref: "#/definitions/tunnel_per_page"
query.page — Optional $ref: "#/definitions/tunnel_page_number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk create URL Scans — cloudflare.urlscanner-create-scan-bulk-v2

Submit URLs to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/ and take into account scans submitted in bulk have lower priority and may take longer to finish.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body array Optional List of urls to scan (up to a 100).
body[] object Optional
body[].agentReadiness boolean Optional Enable agent readiness checks.
body[].customHeaders object Optional Set custom headers. additionalProperties: {"type":"string"}
body[].customagent string Optional maxLength: 4096
body[].referer string Optional maxLength: 4096
body[].screenshotsResolutions array Optional Take multiple screenshots targeting different device types. default: ["desktop"]
body[].screenshotsResolutions[] string Optional Device resolutions. enum: ["desktop","mobile","tablet"]; default: "desktop"
body[].url string Required
body[].visibility string Optional The option Public means it will be included in listings like recent scans and search results. Unlisted means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material. enum: ["Public","Unlisted"]; default: "Public"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get URL scan's DOM — cloudflare.urlscanner-get-scan-dom-v2

Returns a plain text response, with the scan's DOM content as rendered by Chrome.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.scan_id string Required Scan UUID. format: "uuid"
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "scan_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get URL scan's HAR — cloudflare.urlscanner-get-scan-har-v2

Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.scan_id string Required Scan UUID. format: "uuid"
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "scan_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get raw response — cloudflare.urlscanner-get-response-v2

Returns the raw response of the network request. Find the response_id in the data.requests.response.hash.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.response_id string Required Response hash.
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "response_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get URL scan — cloudflare.urlscanner-get-scan-v2

Get URL scan by uuid

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.scan_id string Required Scan UUID. format: "uuid"
path.account_id string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "scan_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create URL Scan — cloudflare.urlscanner-create-scan-v2

Submit a URL to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body object Optional
body.agentReadiness boolean Optional Enable agent readiness checks.
body.country string Optional Country to geo egress from enum: ["AE","AL","AM","AO","AR","AT","AU","AZ","BB","BD","BE","BF","BG","BH","BN","BO","BR","BT","BW","BY","CA","CD","CH","CI","CL","CM","CO","CR","CW","CY","CZ","DE","DJ","DK","DO","DZ","EC","EE","EG","ES","ET","FI","FJ","FR","GB","GD","GE","GH","GR","GT","GU","GY","HK","HN","HR","HT","HU","ID","IE","IL","IN","IQ","IS","IT","JM","JO","JP","KE","KG","KH","KR","KW","KZ","LA","LB","LK","LR","LT","LU","LV","MA","MD","MG","MK","MM","MN","MO","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NG","NL","NO","NP","NZ","OM","PA","PE","PF","PH","PK","PL","PR","PS","PT","PY","QA","RE","RO","RS","RU","RW","SA","SE","SG","SI","SK","SN","SR","TH","TJ","TN","TR","TT","TW","TZ","UA","UG","US","UZ","VN","ZA","ZM","ZW"]
body.customHeaders object Optional Set custom headers. additionalProperties: {"type":"string"}
body.customagent string Optional maxLength: 4096
body.referer string Optional maxLength: 4096
body.screenshotsResolutions array Optional Take multiple screenshots targeting different device types. default: ["desktop"]
body.screenshotsResolutions[] string Optional Device resolutions. enum: ["desktop","mobile","tablet"]; default: "desktop"
body.url string Required
body.visibility string Optional The option Public means it will be included in listings like recent scans and search results. Unlisted means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material. enum: ["Public","Unlisted"]; default: "Public"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get screenshot — cloudflare.urlscanner-get-scan-screenshot-v2

Get scan's screenshot by resolution (desktop/mobile/tablet).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.scan_id string Required Scan UUID. format: "uuid"
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.resolution string Optional Target device type. enum: ["desktop","mobile","tablet"]; default: "desktop"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "scan_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search URL scans — cloudflare.urlscanner-search-scans-v2

Use a subset of ElasticSearch Query syntax to filter scans. Some example queries: - 'path:"/bundles/jquery.js"': Searches for scans who requested resources with the given path. - 'page.asn:AS24940 AND hash:xxx': Websites hosted in AS24940 where a resource with the given hash was downloaded. - 'page.domain:microsoft AND verdicts.malicious:true AND NOT page.domain:microsoft.com': malicious scans whose hostname starts with "microsoft". - 'apikey:me AND date:[2025-01 TO 2025-02]': my scans from 2025 January to 2025 February.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
query object Optional additionalProperties: false
query.size integer Optional Limit the number of objects in the response.
query.q string Optional Filter scans

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Vectorize Indexes — cloudflare.vectorize-list-vectorize-indexes

Returns a list of Vectorize Indexes

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Vectorize Index — cloudflare.vectorize-create-vectorize-index

Creates and returns a new Vectorize Index.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
body — Required $ref: "#/definitions/vectorize_create-index-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "example-index",
    "config": {
      "dimensions": 768,
      "metric": "cosine"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Vectorize Index — cloudflare.vectorize-delete-vectorize-index

Deletes the specified Vectorize Index.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Vectorize Index — cloudflare.vectorize-get-vectorize-index

Returns the specified Vectorize Index.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Vectors By Identifier — cloudflare.vectorize-delete-vectors-by-id

Delete a set of vectors from an index by their vector identifiers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"
body — Required $ref: "#/definitions/vectorize_index-delete-vectors-by-id-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Vectors By Identifier — cloudflare.vectorize-get-vectors-by-id

Get a set of vectors from an index by their vector identifiers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"
body — Required $ref: "#/definitions/vectorize_index-get-vectors-by-id-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Vectorize Index Info — cloudflare.vectorize-index-info

Get information about a vectorize index.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Vectors — cloudflare.vectorize-list-vectors

Returns a paginated list of vector identifiers from the specified index.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"
query object Optional additionalProperties: false
query.count integer Optional Maximum number of vectors to return default: 100; minimum: 1; maximum: 1000
query.cursor string Optional Cursor for pagination to get the next page of results

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Metadata Index — cloudflare.vectorize-create-metadata-index

Enable metadata filtering based on metadata property. Limited to 10 properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"
body — Required $ref: "#/definitions/vectorize_create-metadata-index-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  },
  "body": {
    "propertyName": "random_metadata_property",
    "indexType": "string"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Metadata Index — cloudflare.vectorize-delete-metadata-index

Allow Vectorize to delete the specified metadata index.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"
body — Required $ref: "#/definitions/vectorize_delete-metadata-index-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  },
  "body": {
    "propertyName": "random_metadata_property"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Metadata Indexes — cloudflare.vectorize-list-metadata-indexes

List Metadata Indexes for the specified Vectorize Index.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query Vectors — cloudflare.vectorize-query-vector

Finds vectors closest to a given vector in an index.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/vectorize_identifier"
path.index_name — Required $ref: "#/definitions/vectorize_index-name"
body — Required $ref: "#/definitions/vectorize_index-query-v2-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "index_name": "example-index"
  },
  "body": {
    "vector": [
      0.5,
      0.5,
      0.5
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List credential sets — cloudflare.list-credential-sets

Returns all credential sets for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create credential set — cloudflare.create-credential-set

Creates a new credential set.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
body — Required $ref: "#/definitions/vuln_scanner_create-credential-set-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Production API credentials"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete credential set — cloudflare.delete-credential-set

Deletes a credential set and all of its credentials.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get credential set — cloudflare.get-credential-set

Returns a single credential set by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit credential set — cloudflare.edit-credential-set

Updates a credential set with only the provided fields; omitted fields remain unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
body — Required $ref: "#/definitions/vuln_scanner_patch-credential-set-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update credential set — cloudflare.update-credential-set

Replaces a credential set. All fields must be provided.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
body — Required $ref: "#/definitions/vuln_scanner_update-credential-set-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "Production API credentials"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List credentials — cloudflare.list-credentials

Returns all credentials within a credential set.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create credential — cloudflare.create-credential

Creates a new credential within a credential set.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
body — Required $ref: "#/definitions/vuln_scanner_create-credential-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "Admin API key",
    "location": "header",
    "location_name": "Authorization",
    "value": "Bearer EXAMPLE_TOKEN"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete credential — cloudflare.delete-credential

Deletes a credential.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
path.credential_id string Required Credential identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000",
    "credential_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get credential — cloudflare.get-credential

Returns a single credential by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
path.credential_id string Required Credential identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000",
    "credential_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit credential — cloudflare.edit-credential

Updates a credential with only the provided fields; omitted fields remain unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
path.credential_id string Required Credential identifier. format: "uuid"
body — Required $ref: "#/definitions/vuln_scanner_patch-credential-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000",
    "credential_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update credential — cloudflare.update-credential

Replaces a credential. All fields must be provided.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.credential_set_id string Required Credential set identifier. format: "uuid"
path.credential_id string Required Credential identifier. format: "uuid"
body — Required $ref: "#/definitions/vuln_scanner_update-credential-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "credential_set_id": "00000000-0000-4000-8000-000000000000",
    "credential_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "Admin API key",
    "location": "header",
    "location_name": "Authorization",
    "value": "Bearer EXAMPLE_TOKEN"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List scans — cloudflare.list-scans

Returns all scans for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create scan — cloudflare.create-scan

Creates and starts a new vulnerability scan. The response may include non-fatal warnings in the messages array.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
body — Required $ref: "#/definitions/vuln_scanner_create-scan-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "target_environment_id": "00000000-0000-4000-8000-000000000000",
    "scan_type": "bola",
    "open_api": "example",
    "credential_sets": {
      "owner": "00000000-0000-4000-8000-000000000000",
      "attacker": "00000000-0000-4000-8000-000000000000"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete scan — cloudflare.delete-scan

Deletes a scan and all associated data. Only scans in a terminal state (finished, failed) may be deleted. Attempting to delete a scan that is still being created or executed (created, scheduled, planning, running) returns 400.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.scan_id string Required Scan identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "scan_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get scan — cloudflare.get-scan

Returns a single scan by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.scan_id string Required Scan identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "scan_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List target environments — cloudflare.list-target-environments

Returns all target environments for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create target environment — cloudflare.create-target-environment

Creates a new target environment for the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
body — Required $ref: "#/definitions/vuln_scanner_create-target-environment-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Production Zone",
    "target": {
      "type": "zone",
      "zone_tag": "d8e8fca2dc0f896fd7cb4cb0031ba249"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete target environment — cloudflare.delete-target-environment

Removes a target environment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.target_environment_id string Required Target environment identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "target_environment_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get target environment — cloudflare.get-target-environment

Returns a single target environment by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.target_environment_id string Required Target environment identifier. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "target_environment_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit target environment — cloudflare.edit-target-environment

Updates a target environment with only the provided fields; omitted fields remain unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.target_environment_id string Required Target environment identifier. format: "uuid"
body — Required $ref: "#/definitions/vuln_scanner_patch-target-environment-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "target_environment_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update target environment — cloudflare.update-target-environment

Replaces a target environment. All fields must be provided.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required Account identifier. $ref: "#/definitions/vuln_scanner_identifier"
path.target_environment_id string Required Target environment identifier. format: "uuid"
body — Required $ref: "#/definitions/vuln_scanner_update-target-environment-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "target_environment_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "name": "Production Zone",
    "target": {
      "type": "zone",
      "zone_tag": "d8e8fca2dc0f896fd7cb4cb0031ba249"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List waiting rooms for account — cloudflare.waiting-room-list-waiting-rooms-account

Lists waiting rooms for account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/waitingroom_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. Must be a multiple of 5. default: 25; minimum: 5; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Mesh nodes — cloudflare.cloudflare-tunnel-list-warp-connector-tunnels

Lists and filters Mesh nodes in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.name string Optional A user-friendly name for the tunnel.
query.is_deleted boolean Optional If true, only include deleted tunnels. If false, exclude deleted tunnels. If empty, all tunnels will be included.
query.existed_at — Optional $ref: "#/definitions/tunnel_existed_at"
query.uuid — Optional $ref: "#/definitions/tunnel_tunnel_id"
query.was_active_at string Optional format: "date-time"
query.was_inactive_at string Optional format: "date-time"
query.include_prefix string Optional
query.exclude_prefix string Optional
query.status — Optional $ref: "#/definitions/tunnel_status"
query.per_page — Optional $ref: "#/definitions/tunnel_per_page"
query.page — Optional $ref: "#/definitions/tunnel_page_number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Mesh node — cloudflare.cloudflare-tunnel-create-a-warp-connector-tunnel

Creates a new Mesh node in an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.ha boolean Optional Indicates that the tunnel will be created to be highly available. If omitted, defaults to false. default: false
body.name — Required $ref: "#/definitions/tunnel_tunnel_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "blog"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Mesh node — cloudflare.cloudflare-tunnel-delete-a-warp-connector-tunnel

Deletes a Mesh node from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Mesh node — cloudflare.cloudflare-tunnel-get-a-warp-connector-tunnel

Fetches a single Mesh node.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Mesh node — cloudflare.cloudflare-tunnel-update-a-warp-connector-tunnel

Updates an existing Mesh node.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
body object Required
body.name — Optional $ref: "#/definitions/tunnel_tunnel_name"
body.tunnel_secret — Optional $ref: "#/definitions/tunnel_tunnel_secret"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Mesh node HA configuration — cloudflare.cloudflare-tunnel-configuration-get-warp-connector-configuration

Gets the high-availability configuration for a Mesh node.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_identifier"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Mesh node HA configuration — cloudflare.cloudflare-tunnel-configuration-update-warp-connector-configuration

Adds or updates the high-availability configuration for a Mesh node.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_identifier"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id-2"
body — Required $ref: "#/definitions/tunnel_mesh_configuration_request_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "ha_mode": "aws"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Mesh node connections — cloudflare.cloudflare-tunnel-list-warp-connector-tunnel-connections

Lists connection details for a Mesh node.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Mesh node connector — cloudflare.cloudflare-tunnel-get-warp-connector-tunnel-connector

Fetches connector and connection details for a Mesh node.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
path.connector_id — Required $ref: "#/definitions/tunnel_client_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "connector_id": "1bedc50d-42b3-473c-b108-ff3d10c0d925"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger a manual failover for a Mesh node — cloudflare.cloudflare-tunnel-manual-failover-warp-connector-tunnel

Triggers a manual failover for a specific Mesh node, setting the specified client as the active connector. The tunnel must be configured for high availability (HA) and the client must be linked to the tunnel.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"
body object Required
body.client_id — Required
body.client_id — Required allOf[1]; $ref: "#/definitions/tunnel_client_id_input"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {
    "client_id": "1bedc50d-42b3-473c-b108-ff3d10c0d925"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Mesh node token — cloudflare.cloudflare-tunnel-get-a-warp-connector-tunnel-token

Gets the token used to associate a WARP device with a specific Mesh node.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.tunnel_id — Required $ref: "#/definitions/tunnel_tunnel_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch Workers Account Settings — cloudflare.worker-account-settings-fetch-worker-account-settings

Fetches Workers account settings for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Configure Workers Account Settings — cloudflare.worker-account-settings-create-worker-account-settings

Configure Workers account settings for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
body — Required $ref: "#/definitions/workers_account-settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Workers for Platforms Dispatch Namespaces — cloudflare.namespace-worker-list

Fetch a list of Workers for Platforms dispatch namespaces.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-create

Create a new Workers for Platforms dispatch namespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
body object Required
body.name string Optional The name of the dispatch namespace.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-delete-namespace

Delete a Workers for Platforms dispatch namespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-get-namespace

Get a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-patch-namespace

Patch a Workers for Platforms dispatch namespace. Omitted fields are left unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
body object Required
body.name string Optional The name of the dispatch namespace.
body.trusted_workers — Optional $ref: "#/definitions/workers_trusted_workers"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Workers for Platforms Dispatch Namespace — cloudflare.namespace-worker-put-namespace

Update a Workers for Platforms dispatch namespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
body object Required
body.name string Optional The name of the dispatch namespace.
body.trusted_workers — Optional $ref: "#/definitions/workers_trusted_workers"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Workers for Platforms Scripts — cloudflare.namespace-worker-delete-scripts

Delete multiple scripts from a Workers for Platforms dispatch namespace based on optional tag filters.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
query object Required additionalProperties: false
query.tags string Required Filter scripts by tags before deletion. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.
query.limit integer Optional Limit the number of scripts to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace"
  },
  "query": {
    "tags": "production:yes,staging:no"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Workers for Platforms Scripts — cloudflare.namespace-worker-list-scripts

Fetch a list of scripts uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
query object Optional additionalProperties: false
query.tags string Optional Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Workers for Platforms Script — cloudflare.namespace-worker-script-delete-worker

Delete a script from a Workers for Platforms dispatch namespace. This call has no response body on a successful delete.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
query object Optional additionalProperties: false
query.force boolean Optional If true, delete the script even when other Workers still reference it. Service bindings in those Workers may be left broken. Durable Object namespaces implemented by the deleted script are deleted even if other Workers reference them.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers for Platforms Script details — cloudflare.namespace-worker-script-worker-details

Fetch information about a script uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Workers for Platforms Assets Upload Session — cloudflare.namespace-worker-script-update-create-assets-upload-session

Start uploading a collection of assets for use in a Workers for Platforms script version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_create-assets-upload-session-object"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  },
  "body": {
    "manifest": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers for Platforms Script Bindings — cloudflare.namespace-worker-get-script-bindings

Fetch bindings from a script uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers for Platforms Script Content — cloudflare.namespace-worker-get-script-content

Fetch content from a script uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Workers for Platforms Script Secrets — cloudflare.namespace-worker-list-script-secrets

List secrets bound to a script uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a secret to a Workers for Platforms script — cloudflare.namespace-worker-put-script-secrets

Add a secret to a Workers for Platforms script by creating a new version with that secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_secret"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  },
  "body": {
    "name": "myBinding",
    "type": "secret_text",
    "text": "My secret."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch multiple Workers for Platforms script secrets — cloudflare.namespace-worker-patch-script-secrets-bulk

Create, update, or delete multiple secrets on a Workers for Platforms script in a single operation using JSON Merge Patch (RFC 7396). This operation creates a single version with all changes included. Prefer this API instead of changing many secrets individually.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_secret-patch-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Workers for Platforms script secret — cloudflare.namespace-worker-delete-script-secret

Remove a secret from a Workers for Platforms script by creating a new version without that secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.secret_name — Required $ref: "#/definitions/workers_secret_name"
query object Optional additionalProperties: false
query.url_encoded — Optional $ref: "#/definitions/workers_secret_name_url_encoded"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01",
    "secret_name": "mySecret"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers for Platforms Script Secret — cloudflare.namespace-worker-get-script-secrets

Get a given secret binding (value omitted) on a script uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.secret_name — Required $ref: "#/definitions/workers_secret_name"
query object Optional additionalProperties: false
query.url_encoded — Optional $ref: "#/definitions/workers_secret_name_url_encoded"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01",
    "secret_name": "mySecret"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers for Platforms Script Settings — cloudflare.namespace-worker-get-script-settings

Get settings for a script uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Workers for Platforms Script Tags — cloudflare.namespace-worker-get-script-tags

Fetch tags from a script uploaded to a Workers for Platforms dispatch namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Workers for Platforms Script Tags — cloudflare.namespace-worker-put-script-tags

Replace tags for a script uploaded to a Workers for Platforms dispatch namespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_tags"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01"
  },
  "body": [
    "my-team",
    "my-public-api"
  ]
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Workers for Platforms Script Tag — cloudflare.namespace-worker-patch-script-tag

Add or update one tag key/value on a script uploaded to a Workers for Platforms dispatch namespace without replacing its other tags.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.tag — Required Tag key. Cloudflare-reserved prefixes are not accepted. $ref: "#/definitions/workers_typed_tag_key"
headers object Optional additionalProperties: false
headers.api-version string Optional Requested API compatibility date in YYYY-MM-DD[.release] format (UTC). The optional release suffix contains lowercase letters; for example, 2026-10-01.epoch. Typed Worker tag operations require a date on or after 2026-10-01. pattern: "^\\d{4}-\\d{2}-\\d{2}(\\.[a-z]+)?$"
body — Required $ref: "#/definitions/workers_tag_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01",
    "tag": "environment"
  },
  "body": {
    "value": "production"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Workers for Platforms Script Tag — cloudflare.namespace-worker-put-script-tag

Add a single tag to a script uploaded to a Workers for Platforms dispatch namespace.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.dispatch_namespace — Required $ref: "#/definitions/workers_dispatch_namespace_name"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.tag — Required $ref: "#/definitions/workers_tag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "dispatch_namespace": "my-dispatch-namespace",
    "script_name": "this-is_my_script-01",
    "tag": "my-tag"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Worker Domains — cloudflare.workers.domains.list

Lists all Worker domains for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
query object Optional additionalProperties: false
query.zone_id string Optional ID of the zone containing the domain hostname.
query.zone_name string Optional Name of the zone containing the domain hostname.
query.service string Optional Name of the Worker associated with the domain.
query.hostname string Optional Hostname of the domain.
query.environment string Optional Worker environment associated with the domain.
query.previews_enabled boolean Optional Whether previews are routable for the domain.
query.enabled boolean Optional Whether the configured hostname is routable for the domain.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Attach Worker Domain — cloudflare.workers.domains.update

Attaches a domain that routes traffic to a Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/workers_Domain"
body object Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "zone_id": "593c9c94de529bbbfaac7c53ced0447d",
    "zone_name": "example.com",
    "hostname": "example",
    "service": "example",
    "previews_enabled": false,
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Detach Worker Domain — cloudflare.workers.domains.delete

Detaches a domain from a Worker. Both the Worker and all of its previews are no longer routable using this domain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.domain_id string Required ID of the domain.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_id": "dbe10b4bc17c295377eabd600e1787fd"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Domain — cloudflare.workers.domains.get

Gets information about a Worker domain.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.domain_id string Required ID of the domain.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "domain_id": "dbe10b4bc17c295377eabd600e1787fd"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Durable Object Namespaces — cloudflare.durable-objects-namespace-list-namespaces

Returns the Durable Object namespaces owned by an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page. default: 1; minimum: 1
query.per_page integer Optional Items per-page. default: 20; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Objects in a Durable Object namespace — cloudflare.durable-objects-namespace-list-objects

Returns the Durable Objects in a given Durable Object namespace.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.id — Required $ref: "#/definitions/workers_schemas-id"
query object Optional additionalProperties: false
query.limit number Optional The number of objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit. default: 1000; minimum: 10; maximum: 10000
query.cursor string Optional Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "5fd1cafff895419c8bcc647fc64ab8f0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query a Durable Object — cloudflare.durable-objects-namespace-query

Executes one or more SQL queries against a Durable Object.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.id — Required $ref: "#/definitions/workers_schemas-id"
body — Required
body — Required oneOf[1]; $ref: "#/definitions/workers_query-by-id"
body — Required oneOf[2]; $ref: "#/definitions/workers_query-by-name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "id": "5fd1cafff895419c8bcc647fc64ab8f0"
  },
  "body": {
    "durable_object_id": "example",
    "queries": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Agent sessions — cloudflare.agents.sessions.list

Lists sessions in which the specified agent participated, ordered by most recent activity. A session is identified by gen_ai.conversation.id and includes authorized activity from every agent in that conversation during the requested time range. Agent invocation and chat spans without a conversation ID are attributed only when their trace is associated with exactly one observed conversation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
query object Required additionalProperties: false
query.service string Required Worker service name associated with the participating agent. minLength: 1; maxLength: 512
query.agent string Required Agent name reported in gen_ai.agent.name. The request is limited to conversations in which this service and agent participated. minLength: 1; maxLength: 512
query.from integer Required Start of the requested time range, as Unix epoch milliseconds. Values earlier than the 7-day retention boundary are clamped. minimum: 0
query.to integer Required End of the requested time range, as Unix epoch milliseconds. Must be later than from. minimum: 0
query.cursor string Optional Opaque cursor from result_info.cursors.after in the previous response. minLength: 1; maxLength: 2048
query.per_page integer Optional Maximum number of items to return. Defaults to 20 and cannot exceed 100. minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "service": "example",
    "agent": "example",
    "from": 1,
    "to": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Agent session runs — cloudflare.agents.sessions.runs.list

Lists the traces associated with a session, ordered by most recent activity. The service and agent parameters must identify an agent that participated in the conversation. Results include every authorized trace containing an agent invocation in that conversation during the requested time range.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.conversationId string Required OpenTelemetry gen_ai.conversation.id value that identifies the session. minLength: 1; maxLength: 512
query object Required additionalProperties: false
query.service string Required Worker service name associated with the participating agent. minLength: 1; maxLength: 512
query.agent string Required Agent name reported in gen_ai.agent.name. The request is limited to conversations in which this service and agent participated. minLength: 1; maxLength: 512
query.from integer Required Start of the requested time range, as Unix epoch milliseconds. Values earlier than the 7-day retention boundary are clamped. minimum: 0
query.to integer Required End of the requested time range, as Unix epoch milliseconds. Must be later than from. minimum: 0
query.cursor string Optional Opaque cursor from result_info.cursors.after in the previous response. minLength: 1; maxLength: 2048
query.per_page integer Optional Maximum number of items to return. Defaults to 20 and cannot exceed 100. minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "conversationId": "example"
  },
  "query": {
    "service": "example",
    "agent": "example",
    "from": 1,
    "to": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Destinations — cloudflare.destination.list

List your Workers Observability Telemetry Destinations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
query object Optional additionalProperties: false
query.page number Optional default: 1; minimum: 1
query.perPage number Optional default: 20; minimum: 5; maximum: 50
query.order string Optional enum: ["asc","desc"]; default: "desc"
query.orderBy string Optional enum: ["created","updated"]; default: "updated"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Destination — cloudflare.destination.create

Create a new Workers Observability Telemetry Destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Optional
body.configuration object Required
body.configuration.headers object Required additionalProperties: {"type":"string"}
body.configuration.logpushDataset — Required
body.configuration.logpushDataset string Required anyOf[1]; enum: ["opentelemetry-traces"]
body.configuration.logpushDataset string Required anyOf[2]; enum: ["opentelemetry-logs"]
body.configuration.logpushDataset string Required anyOf[3]; enum: ["opentelemetry-metrics"]
body.configuration.type string Required enum: ["logpush"]
body.configuration.url string Required
body.enabled boolean Required
body.name string Required pattern: "^[a-z0-9][a-z0-9-]*[a-z0-9]$"
body.skipPreflightCheck boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Destination — cloudflare.destinations.delete

Delete a Workers Observability Telemetry Destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.slug string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Destination — cloudflare.destination.update

Update an existing Workers Observability Telemetry Destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.slug string Required
body object Optional
body.configuration object Optional
body.configuration.headers object Required additionalProperties: {"type":["string","null"]}
body.configuration.replaceHeaders boolean Optional
body.configuration.type string Required enum: ["logpush"]
body.configuration.url string Required
body.enabled boolean Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List detected issues — cloudflare.issues.list

List detected issues.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
query object Optional additionalProperties: false
query.page integer Optional minimum: 1
query.perPage integer Optional minimum: 1; maximum: 100
query.order string Optional enum: ["asc","desc"]
query.orderBy string Optional enum: ["id","service","title","type","status","statusUpdated","count","firstObserved","lastObserved","created","updated"]
query.search string Optional maxLength: 256
query.service string Optional
query.type string Optional minLength: 1; maxLength: 32
query.status string Optional enum: ["active","resolved","ignored"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue automations — cloudflare.issues.automations.list

List account and service issue automations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
query object Optional additionalProperties: false
query.service string Optional minLength: 1; maxLength: 128

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an issue automation — cloudflare.issues.automations.create

Create an account or service issue automation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required additionalProperties: false
body.afterInactivitySeconds integer Optional minimum: 3600; maximum: 31536000
body.afterOccurrences integer Optional minimum: 1; maximum: 9007199254740991
body.enabled boolean Optional
body.name string Optional minLength: 1; maxLength: 200
body.policyId string Required minLength: 1; maxLength: 200
body.service string Optional minLength: 1; maxLength: 128

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "policyId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an issue automation — cloudflare.issues.automations.delete

Delete an issue automation while preserving its historical runs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.automationId string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "automationId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an issue automation — cloudflare.issues.automations.get

Retrieve an issue automation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.automationId string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "automationId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an issue automation — cloudflare.issues.automations.update

Replace an issue automation configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.automationId string Required minLength: 1
body object Required additionalProperties: false
body.afterInactivitySeconds integer Optional minimum: 3600; maximum: 31536000
body.afterOccurrences integer Optional minimum: 1; maximum: 9007199254740991
body.enabled boolean Optional
body.name string Optional minLength: 1; maxLength: 200
body.policyId string Required minLength: 1; maxLength: 200
body.service string Optional minLength: 1; maxLength: 128

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "automationId": "example"
  },
  "body": {
    "policyId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an issue group — cloudflare.issues.groups.create

Group two or more issues under a new customer-defined identity.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.issueIds array Required minItems: 2; maxItems: 100
body.issueIds[] string Optional minLength: 1
body.title string Required minLength: 1; maxLength: 128

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "title": "example",
    "issueIds": [
      "example",
      "example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Dissolve an issue group — cloudflare.issues.groups.delete

Dissolve an issue group and restore its members as standalone issues.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.groupId string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "groupId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add issue group members — cloudflare.issues.groups.members.add

Add one or more ungrouped issues to an existing issue group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.groupId string Required minLength: 1
body object Required
body.issueIds array Required minItems: 1; maxItems: 100
body.issueIds[] string Optional minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "groupId": "example"
  },
  "body": {
    "issueIds": [
      "example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an issue group member — cloudflare.issues.groups.members.remove

Remove an issue from a group, dissolving the group when fewer than two members remain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.groupId string Required minLength: 1
path.issueId string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "groupId": "example",
    "issueId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Summarize detected issues — cloudflare.issues.summary

Retrieve aggregate issue counts for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
query object Optional additionalProperties: false
query.service string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an issue — cloudflare.issues.get

Retrieve an issue.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.issueId string Required minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "issueId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Modify an issue — cloudflare.issues.patch

Modify an issue status or group title.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.issueId string Required minLength: 1
body object Required
body.status string Optional enum: ["active","resolved","ignored"]
body.title string Optional minLength: 1; maxLength: 128

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "issueId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Notify about an issue — cloudflare.issues.notificationruns.create

Send the issue to one ANS policy, or every matching Real-Time Issue policy when no policy ID is provided.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.issueId string Required minLength: 1
body object Required additionalProperties: false
body.policyId string Optional minLength: 1; maxLength: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "issueId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List issue occurrences — cloudflare.issues.occurrences.list

List the retained error occurrences grouped into an issue, newest first.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.issueId string Required Issue ID returned by the issues API. minLength: 1
query object Optional additionalProperties: false
query.cursor string Optional Opaque cursor returned in result_info.cursors.after. minLength: 1; maxLength: 512
query.per_page integer Optional minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "issueId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Metrics Exports — cloudflare.metricsexport.list

List resources configured for Workers Observability metrics export.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upsert Metrics Exports — cloudflare.metricsexport.upsert

Create or replace resources configured for Workers Observability metrics export.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Optional additionalProperties: false
body.requester object Required additionalProperties: false
body.requester.requesterId string Required minLength: 1
body.requester.requesterType string Required enum: ["workers"]
body.resources array Required
body.resources[] object Optional additionalProperties: false
body.resources[].destinations array Required minItems: 1
body.resources[].destinations[] string Optional minLength: 1
body.resources[].resourceId string Required minLength: 1
body.resources[].resourceType string Required enum: ["workers","d1","r2","containers"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List queries — cloudflare.queries.list

List saved queries.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
query object Optional additionalProperties: false
query.page number Optional default: 1; minimum: 1
query.perPage number Optional default: 20; minimum: 5; maximum: 50
query.order string Optional enum: ["asc","desc"]; default: "desc"
query.orderBy string Optional enum: ["created","updated"]; default: "updated"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Save query — cloudflare.queries.post

Persist query for later use.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.description string | null Required maxLength: 1000
body.name string Required Query name minLength: 1; maxLength: 250
body.parameters object Required
body.parameters.calculations array Optional Create Calculations to compute as part of the query.
body.parameters.calculations[] — Optional
body.parameters.calculations[] object Optional oneOf[1]
body.parameters.calculations[].alias string Optional oneOf[1]
body.parameters.calculations[].key string Optional oneOf[1]
body.parameters.calculations[].keyType string Optional oneOf[1]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required oneOf[1]; enum: ["count","COUNT"]
body.parameters.calculations[] object Optional oneOf[2]
body.parameters.calculations[].alias string Optional oneOf[2]
body.parameters.calculations[].key string Required oneOf[2]; pattern: "\\S"
body.parameters.calculations[].keyType string Optional oneOf[2]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required oneOf[2]; enum: ["uniq","max","min","sum","avg","median","p001","p01","p05","p10","p25","p75","p90","p95","p99","p999","stddev","variance","COUNT_DISTINCT","MAX","MIN","SUM","AVG","MEDIAN","P001","P01","P05","P10","P25","P75","P90","P95","P99","P999","STDDEV","VARIANCE"]
body.parameters.datasets array Optional Set the Datasets to query. Leave it empty to query all the datasets.
body.parameters.datasets[] string Optional
body.parameters.filterCombination string Optional Set a Flag to describe how to combine the filters on the query. enum: ["and","or","AND","OR"]
body.parameters.filters array Optional Configure the Filters to apply to the query. Supports nested groups via kind: 'group'.
body.parameters.filters[] — Optional $ref: "#/definitions/workers-observability_filter_node"
body.parameters.groupBys array Optional Define how to group the results of the query.
body.parameters.groupBys[] object Optional
body.parameters.groupBys[].type string Required enum: ["string","number","boolean"]
body.parameters.groupBys[].value string Required
body.parameters.havings array Optional Configure the Having clauses that filter on calculations in the query result.
body.parameters.havings[] object Optional
body.parameters.havings[].key string Required
body.parameters.havings[].operation string Required enum: ["eq","neq","gt","gte","lt","lte"]
body.parameters.havings[].value number Required
body.parameters.limit integer Optional Set a limit on the number of results / records returned by the query minimum: 0; maximum: 100
body.parameters.needle object Optional Define an expression to search using full-text search.
body.parameters.needle.isRegex boolean Optional
body.parameters.needle.matchCase boolean Optional
body.parameters.needle.value — Required
body.parameters.needle.value — Required allOf[1]
body.parameters.needle.value string Required allOf[1]; anyOf[1]
body.parameters.needle.value number Required allOf[1]; anyOf[2]
body.parameters.needle.value boolean Required allOf[1]; anyOf[3]
body.parameters.needle.value string Required allOf[2]; maxLength: 1000
body.parameters.orderBy object Optional Configure the order of the results returned by the query.
body.parameters.orderBy.order string Optional Set the order of the results enum: ["asc","desc"]
body.parameters.orderBy.value string Required Configure which Calculation to order the results by.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "description": "Query description",
    "name": "example",
    "parameters": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete query — cloudflare.queries.delete

Delete a saved query.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.queryId string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "queryId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get query — cloudflare.queries.get

Retrieve a saved query.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.queryId string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "queryId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update query — cloudflare.queries.patch

Update saved query.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.queryId string Required
body object Required
body.description string | null Required maxLength: 1000
body.name string Required Query name minLength: 1; maxLength: 250
body.parameters object Required
body.parameters.calculations array Optional Create Calculations to compute as part of the query.
body.parameters.calculations[] — Optional
body.parameters.calculations[] object Optional oneOf[1]
body.parameters.calculations[].alias string Optional oneOf[1]
body.parameters.calculations[].key string Optional oneOf[1]
body.parameters.calculations[].keyType string Optional oneOf[1]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required oneOf[1]; enum: ["count","COUNT"]
body.parameters.calculations[] object Optional oneOf[2]
body.parameters.calculations[].alias string Optional oneOf[2]
body.parameters.calculations[].key string Required oneOf[2]; pattern: "\\S"
body.parameters.calculations[].keyType string Optional oneOf[2]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required oneOf[2]; enum: ["uniq","max","min","sum","avg","median","p001","p01","p05","p10","p25","p75","p90","p95","p99","p999","stddev","variance","COUNT_DISTINCT","MAX","MIN","SUM","AVG","MEDIAN","P001","P01","P05","P10","P25","P75","P90","P95","P99","P999","STDDEV","VARIANCE"]
body.parameters.datasets array Optional Set the Datasets to query. Leave it empty to query all the datasets.
body.parameters.datasets[] string Optional
body.parameters.filterCombination string Optional Set a Flag to describe how to combine the filters on the query. enum: ["and","or","AND","OR"]
body.parameters.filters array Optional Configure the Filters to apply to the query. Supports nested groups via kind: 'group'.
body.parameters.filters[] — Optional $ref: "#/definitions/workers-observability_filter_node"
body.parameters.groupBys array Optional Define how to group the results of the query.
body.parameters.groupBys[] object Optional
body.parameters.groupBys[].type string Required enum: ["string","number","boolean"]
body.parameters.groupBys[].value string Required
body.parameters.havings array Optional Configure the Having clauses that filter on calculations in the query result.
body.parameters.havings[] object Optional
body.parameters.havings[].key string Required
body.parameters.havings[].operation string Required enum: ["eq","neq","gt","gte","lt","lte"]
body.parameters.havings[].value number Required
body.parameters.limit integer Optional Set a limit on the number of results / records returned by the query minimum: 0; maximum: 100
body.parameters.needle object Optional Define an expression to search using full-text search.
body.parameters.needle.isRegex boolean Optional
body.parameters.needle.matchCase boolean Optional
body.parameters.needle.value — Required
body.parameters.needle.value — Required allOf[1]
body.parameters.needle.value string Required allOf[1]; anyOf[1]
body.parameters.needle.value number Required allOf[1]; anyOf[2]
body.parameters.needle.value boolean Required allOf[1]; anyOf[3]
body.parameters.needle.value string Required allOf[2]; maxLength: 1000
body.parameters.orderBy object Optional Configure the order of the results returned by the query.
body.parameters.orderBy.order string Optional Set the order of the results enum: ["asc","desc"]
body.parameters.orderBy.value string Required Configure which Calculation to order the results by.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "queryId": "example"
  },
  "body": {
    "description": "Query description",
    "name": "example",
    "parameters": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a sharable link to a query result — cloudflare.shared.query.post

Shared queries store the results of a previously run query, allowing you to share the results with others.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.chart boolean Optional When true, includes time-series data in the response.
body.chartType string Optional Controls the SQL shape and response payload for the 'calculations' view. Omitted or 'timeseries_and_aggregate': current behaviour — both the time-series and aggregate queries. 'timeseries': time-series only. 'aggregate': aggregate only. 'distribution': a bucketed 2D histogram (time × value buckets) returned in 'distribution' instead of 'calculations'. 'distribution' is not compatible with 'compare' — combining them returns a 400. enum: ["timeseries_and_aggregate","timeseries","aggregate","distribution"]
body.compare boolean Optional When true, includes a comparison dataset from the previous time period of equal length.
body.distributionScale string Optional Value-axis bucketing for chartType 'distribution'. Omitted or 'log': geometric buckets, best for heavy-tailed latency. 'linear': fixed-width buckets, clearer for narrow or additive ranges. Ignored for other chartTypes. The response echoes the scheme used in distribution.bucketMode. enum: ["log","linear"]
body.dry boolean Optional When true, executes the query without persisting the results. Useful for validation or previewing. default: false
body.granularity number Optional Number of time-series buckets. Only used when view is 'calculations'. Omit to let the system auto-detect an appropriate granularity.
body.ignoreSeries boolean Optional When true, omits time-series data from the response and returns only aggregated values. Reduces response size when series are not needed. default: false
body.limit number Optional Maximum number of events to return when view is 'events'. Also controls the number of group-by rows when view is 'calculations'. default: 50; maximum: 2000
body.offset string Optional Cursor for pagination in event, trace, invocation, and agent views. Pass the $metadata.id of the last event, the trace cursor, or AgentRun.id to fetch the next page.
body.offsetBy number Optional Numeric offset for paginating grouped/pattern results (top-N lists). Use together with limit. Not used by cursor-based pagination.
body.offsetDirection string Optional Pagination direction: 'next' for forward, 'prev' for backward.
body.parameters object Optional Query parameters defining what data to retrieve — filters, calculations, group-bys, and ordering. In practice this should always be provided for ad-hoc queries. Only omit when executing a previously saved query by queryId. Use the keys and values endpoints to discover available fields before building filters.
body.parameters.calculations array Optional Aggregation calculations to compute (e.g. count, avg, p99). Each calculation produces aggregate values and optional time-series data.
body.parameters.calculations[] — Optional
body.parameters.calculations[] object Optional oneOf[1]
body.parameters.calculations[].alias string Optional Custom label for this calculation in the results. Useful for distinguishing multiple calculations. oneOf[1]
body.parameters.calculations[].key string Optional Field name to calculate over. Must exist in the data. Verify with the keys endpoint. Required for every operator except count, which aggregates whole rows and may omit it. oneOf[1]
body.parameters.calculations[].keyType string Optional Data type of the key. Required when key is provided to ensure correct aggregation. oneOf[1]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required Aggregation operator to apply. Examples: count, avg, sum, min, max, median, p90, p95, p99, uniq, stddev, variance. oneOf[1]; enum: ["count","COUNT"]
body.parameters.calculations[] object Optional oneOf[2]
body.parameters.calculations[].alias string Optional Custom label for this calculation in the results. Useful for distinguishing multiple calculations. oneOf[2]
body.parameters.calculations[].key string Required Field name to calculate over. Must exist in the data. Verify with the keys endpoint. Required for every operator except count, which aggregates whole rows and may omit it. oneOf[2]; pattern: "\\S"
body.parameters.calculations[].keyType string Optional Data type of the key. Required when key is provided to ensure correct aggregation. oneOf[2]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required Aggregation operator to apply. Examples: count, avg, sum, min, max, median, p90, p95, p99, uniq, stddev, variance. oneOf[2]; enum: ["uniq","max","min","sum","avg","median","p001","p01","p05","p10","p25","p75","p90","p95","p99","p999","stddev","variance","COUNT_DISTINCT","MAX","MIN","SUM","AVG","MEDIAN","P001","P01","P05","P10","P25","P75","P90","P95","P99","P999","STDDEV","VARIANCE"]
body.parameters.datasets array Optional Datasets to query. Leave empty to query all available datasets.
body.parameters.datasets[] string Optional
body.parameters.filterCombination string Optional Logical operator for combining top-level filters: 'and' (all must match) or 'or' (any must match). Defaults to 'and'. enum: ["and","or","AND","OR"]
body.parameters.filters array Optional Filters to narrow query results. Use the keys and values endpoints to discover available fields before building filters. Supports nested groups via kind: 'group'. Maximum nesting depth is 4.
body.parameters.filters[] — Optional
body.parameters.filters[] — Optional allOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.parameters.filters[] — Optional Supports nested groups via kind: 'group'. Maximum nesting depth is 4. allOf[2]
body.parameters.filters[] object Optional A group node that nests child filters combined with a logical operator. allOf[2]; anyOf[1]
body.parameters.filters[].filterCombination string Required Logical operator for combining child filters: 'and' (all must match) or 'or' (any must match). allOf[2]; anyOf[1]; enum: ["and","or","AND","OR"]
body.parameters.filters[].filters array Required Child filter nodes. Each can be a leaf filter or another nested group. allOf[2]; anyOf[1]; minItems: 1
body.parameters.filters[].filters[] — Optional allOf[2]; anyOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.parameters.filters[].kind string Required Discriminator indicating this is a nested filter group. allOf[2]; anyOf[1]; enum: ["group"]
body.parameters.filters[] — Optional allOf[2]; anyOf[2]; $ref: "#/definitions/workers-observability_filter_leaf"
body.parameters.groupBys array Optional Fields to group calculation results by. Only applicable when the query view is 'calculations'. Produces per-group aggregate values.
body.parameters.groupBys[] object Optional
body.parameters.groupBys[].type string Required Data type of the group-by field. enum: ["string","number","boolean"]
body.parameters.groupBys[].value string Required Field name to group results by (e.g. $metadata.service, $metadata.statusCode).
body.parameters.havings array Optional Post-aggregation filters applied to calculation results. Use to filter groups after aggregation (e.g. only groups where count > 100).
body.parameters.havings[] object Optional
body.parameters.havings[].key string Required Calculation alias or operator to filter on after aggregation.
body.parameters.havings[].operation string Required Numeric comparison operator: eq, neq, gt, gte, lt, lte. enum: ["eq","neq","gt","gte","lt","lte"]
body.parameters.havings[].value number Required Threshold value to compare the calculation result against.
body.parameters.limit integer Optional Maximum number of group-by rows to return in calculation results. A value of 10 is a sensible default for most use cases. minimum: 0; maximum: 2000
body.parameters.needle object Optional Full-text search expression applied across all event fields. Matches events containing the specified text.
body.parameters.needle.isRegex boolean Optional When true, treats the value as a regular expression (RE2 syntax).
body.parameters.needle.matchCase boolean Optional When true, performs a case-sensitive search. Defaults to case-insensitive.
body.parameters.needle.value — Required The text or pattern to search for.
body.parameters.needle.value — Required allOf[1]
body.parameters.needle.value string Required allOf[1]; anyOf[1]
body.parameters.needle.value number Required allOf[1]; anyOf[2]
body.parameters.needle.value boolean Required allOf[1]; anyOf[3]
body.parameters.needle.value string Required allOf[2]; maxLength: 1000
body.parameters.orderBy object Optional Ordering for grouped calculation results. Only effective when a group-by is present.
body.parameters.orderBy.order string Optional Sort direction: 'asc' for ascending, 'desc' for descending. enum: ["asc","desc"]
body.parameters.orderBy.value string Required Alias of the calculation to order results by. Must match the alias (or operator) of a calculation in the query.
body.queryId string Required Identifier for the query. When parameters are omitted, this ID is used to load a previously saved query's parameters. When providing parameters inline, pass any identifier (e.g. an ad-hoc ID).
body.timeframe object Required Timeframe for the query using Unix timestamps in milliseconds. 'from' must be earlier than 'to'. Narrower timeframes produce faster responses and more specific results.
body.timeframe.from integer Required Start timestamp for the query timeframe. Unix timestamp in milliseconds minimum: 0; maximum: 253402300799999
body.timeframe.to integer Required End timestamp for the query timeframe. Unix timestamp in milliseconds minimum: 0; maximum: 253402300799999
body.view string Optional Controls the shape of the response. 'events': individual log lines matching the query. 'calculations': aggregated metrics (count, avg, p99, etc.) with optional group-by breakdowns and time-series. 'invocations': events grouped by request ID. 'traces': distributed trace summaries. 'agents': agent-specific trace summaries. enum: ["traces","events","calculations","invocations","requests","agents"]; default: "calculations"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "queryId": "example",
    "timeframe": {
      "to": 1,
      "from": 1
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

View a query that has been shared — cloudflare.shared.query.get

Shared queries store the results of a previously run query, allowing you to share the results with others.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
path.id string Required Specify the ID of the shared query.
query object Optional additionalProperties: false
query.view string Optional Select the view of the query result to return, defaults to events. enum: ["events","invocations","calculations"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List keys — cloudflare.telemetry.keys.list

List all the keys in your telemetry events.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.datasets array Optional Leave this empty to use the default datasets default: []
body.datasets[] string Optional
body.filters array Optional Apply filters to narrow key discovery. Supports nested groups via kind: 'group'. Maximum nesting depth is 4. default: []
body.filters[] — Optional
body.filters[] — Optional allOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.filters[] — Optional Supports nested groups via kind: 'group'. Maximum nesting depth is 4. allOf[2]
body.filters[] object Optional A group node that nests child filters combined with a logical operator. allOf[2]; anyOf[1]
body.filters[].filterCombination string Required Logical operator for combining child filters: 'and' (all must match) or 'or' (any must match). allOf[2]; anyOf[1]; enum: ["and","or","AND","OR"]
body.filters[].filters array Required Child filter nodes. Each can be a leaf filter or another nested group. allOf[2]; anyOf[1]; minItems: 1
body.filters[].filters[] — Optional allOf[2]; anyOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.filters[].kind string Required Discriminator indicating this is a nested filter group. allOf[2]; anyOf[1]; enum: ["group"]
body.filters[] — Optional allOf[2]; anyOf[2]; $ref: "#/definitions/workers-observability_filter_leaf"
body.from number Optional
body.keyNeedle object Optional If the user suggests a key, use this to narrow down the list of keys returned. Make sure matchCase is false to avoid case sensitivity issues.
body.keyNeedle.isRegex boolean Optional When true, treats the value as a regular expression (RE2 syntax).
body.keyNeedle.matchCase boolean Optional When true, performs a case-sensitive search. Defaults to case-insensitive.
body.keyNeedle.value — Required The text or pattern to search for.
body.keyNeedle.value — Required allOf[1]
body.keyNeedle.value string Required allOf[1]; anyOf[1]
body.keyNeedle.value number Required allOf[1]; anyOf[2]
body.keyNeedle.value boolean Required allOf[1]; anyOf[3]
body.keyNeedle.value string Required allOf[2]; maxLength: 1000
body.limit number Optional Advanced usage: set limit=1000+ to retrieve comprehensive key options without needing additional filtering.
body.needle object Optional Search for a specific substring in any of the events
body.needle.isRegex boolean Optional When true, treats the value as a regular expression (RE2 syntax).
body.needle.matchCase boolean Optional When true, performs a case-sensitive search. Defaults to case-insensitive.
body.needle.value — Required The text or pattern to search for.
body.needle.value — Required allOf[1]
body.needle.value string Required allOf[1]; anyOf[1]
body.needle.value number Required allOf[1]; anyOf[2]
body.needle.value boolean Required allOf[1]; anyOf[3]
body.needle.value string Required allOf[2]; maxLength: 1000
body.to number Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Prepare live tail — cloudflare.telemetry.live-tail.post

Prepare websocket server for live tail.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.filterCombination string Optional Set a flag to describe how to combine the filters on the query. enum: ["and","or","AND","OR"]; default: "and"
body.filters array Optional Apply filters to the query. Supports nested groups via kind: 'group'. default: []
body.filters[] — Optional
body.filters[] — Optional allOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.filters[] — Optional Supports nested groups via kind: 'group'. Maximum nesting depth is 4. allOf[2]
body.filters[] object Optional A group node that nests child filters combined with a logical operator. allOf[2]; anyOf[1]
body.filters[].filterCombination string Required Logical operator for combining child filters: 'and' (all must match) or 'or' (any must match). allOf[2]; anyOf[1]; enum: ["and","or","AND","OR"]
body.filters[].filters array Required Child filter nodes. Each can be a leaf filter or another nested group. allOf[2]; anyOf[1]; minItems: 1
body.filters[].filters[] — Optional allOf[2]; anyOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.filters[].kind string Required Discriminator indicating this is a nested filter group. allOf[2]; anyOf[1]; enum: ["group"]
body.filters[] — Optional allOf[2]; anyOf[2]; $ref: "#/definitions/workers-observability_filter_leaf"
body.scriptId string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Live tail heartbeat — cloudflare.telemetry.live-tail.heartbeat.get

Notify live tail that user is still eligible to receive live events.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.scriptId string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run a query — cloudflare.telemetry.query

Run a temporary or saved query.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.chart boolean Optional When true, includes time-series data in the response.
body.chartType string Optional Controls the SQL shape and response payload for the 'calculations' view. Omitted or 'timeseries_and_aggregate': current behaviour — both the time-series and aggregate queries. 'timeseries': time-series only. 'aggregate': aggregate only. 'distribution': a bucketed 2D histogram (time × value buckets) returned in 'distribution' instead of 'calculations'. 'distribution' is not compatible with 'compare' — combining them returns a 400. enum: ["timeseries_and_aggregate","timeseries","aggregate","distribution"]
body.compare boolean Optional When true, includes a comparison dataset from the previous time period of equal length.
body.distributionScale string Optional Value-axis bucketing for chartType 'distribution'. Omitted or 'log': geometric buckets, best for heavy-tailed latency. 'linear': fixed-width buckets, clearer for narrow or additive ranges. Ignored for other chartTypes. The response echoes the scheme used in distribution.bucketMode. enum: ["log","linear"]
body.dry boolean Optional When true, executes the query without persisting the results. Useful for validation or previewing. default: false
body.granularity number Optional Number of time-series buckets. Only used when view is 'calculations'. Omit to let the system auto-detect an appropriate granularity.
body.ignoreSeries boolean Optional When true, omits time-series data from the response and returns only aggregated values. Reduces response size when series are not needed. default: false
body.limit number Optional Maximum number of events to return when view is 'events'. Also controls the number of group-by rows when view is 'calculations'. default: 50; maximum: 2000
body.offset string Optional Cursor for pagination in event, trace, invocation, and agent views. Pass the $metadata.id of the last event, the trace cursor, or AgentRun.id to fetch the next page.
body.offsetBy number Optional Numeric offset for paginating grouped/pattern results (top-N lists). Use together with limit. Not used by cursor-based pagination.
body.offsetDirection string Optional Pagination direction: 'next' for forward, 'prev' for backward.
body.parameters object Optional Query parameters defining what data to retrieve — filters, calculations, group-bys, and ordering. In practice this should always be provided for ad-hoc queries. Only omit when executing a previously saved query by queryId. Use the keys and values endpoints to discover available fields before building filters.
body.parameters.calculations array Optional Aggregation calculations to compute (e.g. count, avg, p99). Each calculation produces aggregate values and optional time-series data.
body.parameters.calculations[] — Optional
body.parameters.calculations[] object Optional oneOf[1]
body.parameters.calculations[].alias string Optional Custom label for this calculation in the results. Useful for distinguishing multiple calculations. oneOf[1]
body.parameters.calculations[].key string Optional Field name to calculate over. Must exist in the data. Verify with the keys endpoint. Required for every operator except count, which aggregates whole rows and may omit it. oneOf[1]
body.parameters.calculations[].keyType string Optional Data type of the key. Required when key is provided to ensure correct aggregation. oneOf[1]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required Aggregation operator to apply. Examples: count, avg, sum, min, max, median, p90, p95, p99, uniq, stddev, variance. oneOf[1]; enum: ["count","COUNT"]
body.parameters.calculations[] object Optional oneOf[2]
body.parameters.calculations[].alias string Optional Custom label for this calculation in the results. Useful for distinguishing multiple calculations. oneOf[2]
body.parameters.calculations[].key string Required Field name to calculate over. Must exist in the data. Verify with the keys endpoint. Required for every operator except count, which aggregates whole rows and may omit it. oneOf[2]; pattern: "\\S"
body.parameters.calculations[].keyType string Optional Data type of the key. Required when key is provided to ensure correct aggregation. oneOf[2]; enum: ["string","number","boolean"]
body.parameters.calculations[].operator string Required Aggregation operator to apply. Examples: count, avg, sum, min, max, median, p90, p95, p99, uniq, stddev, variance. oneOf[2]; enum: ["uniq","max","min","sum","avg","median","p001","p01","p05","p10","p25","p75","p90","p95","p99","p999","stddev","variance","COUNT_DISTINCT","MAX","MIN","SUM","AVG","MEDIAN","P001","P01","P05","P10","P25","P75","P90","P95","P99","P999","STDDEV","VARIANCE"]
body.parameters.datasets array Optional Datasets to query. Leave empty to query all available datasets.
body.parameters.datasets[] string Optional
body.parameters.filterCombination string Optional Logical operator for combining top-level filters: 'and' (all must match) or 'or' (any must match). Defaults to 'and'. enum: ["and","or","AND","OR"]
body.parameters.filters array Optional Filters to narrow query results. Use the keys and values endpoints to discover available fields before building filters. Supports nested groups via kind: 'group'. Maximum nesting depth is 4.
body.parameters.filters[] — Optional
body.parameters.filters[] — Optional allOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.parameters.filters[] — Optional Supports nested groups via kind: 'group'. Maximum nesting depth is 4. allOf[2]
body.parameters.filters[] object Optional A group node that nests child filters combined with a logical operator. allOf[2]; anyOf[1]
body.parameters.filters[].filterCombination string Required Logical operator for combining child filters: 'and' (all must match) or 'or' (any must match). allOf[2]; anyOf[1]; enum: ["and","or","AND","OR"]
body.parameters.filters[].filters array Required Child filter nodes. Each can be a leaf filter or another nested group. allOf[2]; anyOf[1]; minItems: 1
body.parameters.filters[].filters[] — Optional allOf[2]; anyOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.parameters.filters[].kind string Required Discriminator indicating this is a nested filter group. allOf[2]; anyOf[1]; enum: ["group"]
body.parameters.filters[] — Optional allOf[2]; anyOf[2]; $ref: "#/definitions/workers-observability_filter_leaf"
body.parameters.groupBys array Optional Fields to group calculation results by. Only applicable when the query view is 'calculations'. Produces per-group aggregate values.
body.parameters.groupBys[] object Optional
body.parameters.groupBys[].type string Required Data type of the group-by field. enum: ["string","number","boolean"]
body.parameters.groupBys[].value string Required Field name to group results by (e.g. $metadata.service, $metadata.statusCode).
body.parameters.havings array Optional Post-aggregation filters applied to calculation results. Use to filter groups after aggregation (e.g. only groups where count > 100).
body.parameters.havings[] object Optional
body.parameters.havings[].key string Required Calculation alias or operator to filter on after aggregation.
body.parameters.havings[].operation string Required Numeric comparison operator: eq, neq, gt, gte, lt, lte. enum: ["eq","neq","gt","gte","lt","lte"]
body.parameters.havings[].value number Required Threshold value to compare the calculation result against.
body.parameters.limit integer Optional Maximum number of group-by rows to return in calculation results. A value of 10 is a sensible default for most use cases. minimum: 0; maximum: 2000
body.parameters.needle object Optional Full-text search expression applied across all event fields. Matches events containing the specified text.
body.parameters.needle.isRegex boolean Optional When true, treats the value as a regular expression (RE2 syntax).
body.parameters.needle.matchCase boolean Optional When true, performs a case-sensitive search. Defaults to case-insensitive.
body.parameters.needle.value — Required The text or pattern to search for.
body.parameters.needle.value — Required allOf[1]
body.parameters.needle.value string Required allOf[1]; anyOf[1]
body.parameters.needle.value number Required allOf[1]; anyOf[2]
body.parameters.needle.value boolean Required allOf[1]; anyOf[3]
body.parameters.needle.value string Required allOf[2]; maxLength: 1000
body.parameters.orderBy object Optional Ordering for grouped calculation results. Only effective when a group-by is present.
body.parameters.orderBy.order string Optional Sort direction: 'asc' for ascending, 'desc' for descending. enum: ["asc","desc"]
body.parameters.orderBy.value string Required Alias of the calculation to order results by. Must match the alias (or operator) of a calculation in the query.
body.queryId string Required Identifier for the query. When parameters are omitted, this ID is used to load a previously saved query's parameters. When providing parameters inline, pass any identifier (e.g. an ad-hoc ID).
body.timeframe object Required Timeframe for the query using Unix timestamps in milliseconds. 'from' must be earlier than 'to'. Narrower timeframes produce faster responses and more specific results.
body.timeframe.from integer Required Start timestamp for the query timeframe. Unix timestamp in milliseconds minimum: 0; maximum: 253402300799999
body.timeframe.to integer Required End timestamp for the query timeframe. Unix timestamp in milliseconds minimum: 0; maximum: 253402300799999
body.view string Optional Controls the shape of the response. 'events': individual log lines matching the query. 'calculations': aggregated metrics (count, avg, p99, etc.) with optional group-by breakdowns and time-series. 'invocations': events grouped by request ID. 'traces': distributed trace summaries. 'agents': agent-specific trace summaries. enum: ["traces","events","calculations","invocations","requests","agents"]; default: "calculations"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "queryId": "example",
    "timeframe": {
      "to": 1,
      "from": 1
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List values — cloudflare.telemetry.values.list

List unique values found in your events.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
body object Required
body.datasets array Required Leave this empty to use the default datasets
body.datasets[] string Optional
body.filters array Optional Apply filters before listing values. Supports nested groups via kind: 'group'. Maximum nesting depth is 4. default: []
body.filters[] — Optional
body.filters[] — Optional allOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.filters[] — Optional Supports nested groups via kind: 'group'. Maximum nesting depth is 4. allOf[2]
body.filters[] object Optional A group node that nests child filters combined with a logical operator. allOf[2]; anyOf[1]
body.filters[].filterCombination string Required Logical operator for combining child filters: 'and' (all must match) or 'or' (any must match). allOf[2]; anyOf[1]; enum: ["and","or","AND","OR"]
body.filters[].filters array Required Child filter nodes. Each can be a leaf filter or another nested group. allOf[2]; anyOf[1]; minItems: 1
body.filters[].filters[] — Optional allOf[2]; anyOf[1]; $ref: "#/definitions/workers-observability_filter_node"
body.filters[].kind string Required Discriminator indicating this is a nested filter group. allOf[2]; anyOf[1]; enum: ["group"]
body.filters[] — Optional allOf[2]; anyOf[2]; $ref: "#/definitions/workers-observability_filter_leaf"
body.key string Required
body.limit number Optional default: 50
body.needle object Optional Full-text search expression to match events containing the specified text or pattern.
body.needle.isRegex boolean Optional When true, treats the value as a regular expression (RE2 syntax).
body.needle.matchCase boolean Optional When true, performs a case-sensitive search. Defaults to case-insensitive.
body.needle.value — Required The text or pattern to search for.
body.needle.value — Required allOf[1]
body.needle.value string Required allOf[1]; anyOf[1]
body.needle.value number Required allOf[1]; anyOf[2]
body.needle.value boolean Required allOf[1]; anyOf[3]
body.needle.value string Required allOf[2]; maxLength: 1000
body.timeframe object Required
body.timeframe.from number Required
body.timeframe.to number Required
body.type string Required enum: ["string","boolean","number"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "timeframe": {
      "to": 1,
      "from": 1
    },
    "key": "example",
    "type": "string",
    "datasets": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get event count — cloudflare.usage.get

Event counts and sizes broken down by dataset and service, bucketed by day, for up to 90 days. The top-level events field is the sum of all breakdown counts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Your Cloudflare account ID.
query object Required additionalProperties: false
query.from string Required Unix timestamp in milliseconds for the start of the range. minLength: 1
query.to string Required Unix timestamp in milliseconds for the end of the range. minLength: 1
query.tz string Optional IANA timezone used to align daily bins to local midnight (e.g. 'America/Chicago'). Defaults to UTC. minLength: 1; maxLength: 64

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "query": {
    "from": "example",
    "to": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Workers Smart Placement Regions — cloudflare.worker-placement-list-regions

Returns a list of available placement regions organized by cloud provider. These regions can be used to configure Smart Placement for Workers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Worker Scripts — cloudflare.worker-script-list-workers

Fetch a list of uploaded Worker scripts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
query object Optional additionalProperties: false
query.tags string Optional Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search Worker Scripts — cloudflare.worker-script-search-workers

Search for Worker scripts in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
query object Optional additionalProperties: false
query.name string Optional Worker name to search for. Both exact and partial matches are returned.
query.id string Optional Worker ID (also called tag) to search for. Only exact matches are returned.
query.order_by string Optional Property to sort results by. Results are sorted in ascending order. enum: ["created_on","modified_on","name"]; default: "name"
query.page integer Optional Current page. default: 1; minimum: 1
query.per_page integer Optional Items per page. default: 10; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker — cloudflare.worker-script-delete-worker

Delete your worker. This call has no response body on a successful delete.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
query object Optional additionalProperties: false
query.force boolean Optional If true, delete the Worker even when other Workers still reference it. Service bindings in those Workers may be left broken. Durable Object namespaces implemented by the deleted Worker are deleted even if other Workers reference them.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Worker Assets Upload Session — cloudflare.worker-script-update-create-assets-upload-session

Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_create-assets-upload-session-object"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": {
    "manifest": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Script Content — cloudflare.worker-script-get-content

Fetch Worker script content only.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Worker Deployments — cloudflare.worker-deployments-list-deployments

List Worker deployments. The first deployment in the list is the latest deployment actively serving traffic.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
query object Optional additionalProperties: false
query.since string Optional Start of the deployment creation time range, inclusive. format: "date-time"
query.until string Optional End of the deployment creation time range, inclusive. format: "date-time"
query.page integer Optional Current page. default: 1; minimum: 1
query.per_page integer Optional Items per page. default: 10; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Worker Deployment — cloudflare.worker-deployments-create-deployment

Deployments configure how Worker Versions are deployed to traffic. A deployment can consist of multiple versions of a Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
query object Optional additionalProperties: false
query.force boolean Optional If set to true, the deployment will be created even if normally blocked by something such rolling back to an older version when a secret has changed.
body — Required $ref: "#/definitions/workers_deployment"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": {
    "strategy": "percentage",
    "versions": [
      {
        "percentage": 100,
        "version_id": "023e105f-2a42-4f8b-a1c1-73f6a2a30c0f"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker Deployment — cloudflare.worker-deployments-delete-deployment

Delete a Worker Deployment. The latest deployment, which is actively serving traffic, cannot be deleted. All other deployments can be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.deployment_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01",
    "deployment_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Deployment — cloudflare.worker-deployments-get-deployment

Get information about a Worker Deployment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.deployment_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01",
    "deployment_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Script Schedules (Cron Triggers) — cloudflare.worker-cron-trigger-get-cron-triggers

Get the schedules (Cron Triggers) for a Worker script.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Worker Script Schedules (Cron Triggers) — cloudflare.worker-cron-trigger-update-cron-triggers

Update the schedules (Cron Triggers) for a Worker script.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body array Required
body[] — Optional $ref: "#/definitions/workers_schedule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Script Settings — cloudflare.worker-script-settings-get-settings

Get Worker script-level settings when using Worker Versions. Includes Logpush and Tail Consumers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Worker Script Settings — cloudflare.worker-script-settings-patch-settings

Patch Worker script-level settings when using Worker Versions. Including but not limited to Logpush and Tail Consumers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_script-settings-item"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List secrets bound to a Worker script — cloudflare.worker-list-script-secrets

List the names of secrets bound to a Worker script.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a secret to a Worker script — cloudflare.worker-put-script-secret

Add a secret to a Worker script by creating a new version with that secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_secret"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": {
    "name": "myBinding",
    "type": "secret_text",
    "text": "My secret."
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch multiple Worker script secrets — cloudflare.worker-patch-script-secrets-bulk

Create, update, or delete multiple secrets on a Worker script in a single operation using JSON Merge Patch (RFC 7396). This operation creates a single version with all changes included. Prefer this API instead of changing many secrets individually.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body — Required $ref: "#/definitions/workers_secret-patch-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker script secret — cloudflare.worker-delete-script-secret

Remove a secret from a Worker script by creating a new version without that secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.secret_name — Required $ref: "#/definitions/workers_secret_name"
query object Optional additionalProperties: false
query.url_encoded — Optional $ref: "#/definitions/workers_secret_name_url_encoded"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01",
    "secret_name": "mySecret"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a secret binding — cloudflare.worker-get-script-secret

Get a given secret binding (value omitted) on a Worker script.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.secret_name — Required $ref: "#/definitions/workers_secret_name"
query object Optional additionalProperties: false
query.url_encoded — Optional $ref: "#/definitions/workers_secret_name_url_encoded"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01",
    "secret_name": "mySecret"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Script and Version Settings — cloudflare.worker-script-get-settings

Get Worker script metadata and config, such as bindings or usage model.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker Script Subdomain — cloudflare.worker-script-delete-subdomain

Disable all workers.dev subdomains for a Worker script.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Script Subdomain — cloudflare.worker-script-get-subdomain

Get whether a Worker script is available on the workers.dev subdomain.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Worker Script Subdomain — cloudflare.worker-script-post-subdomain

Enable or disable a Worker script on the workers.dev subdomain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body object Required
body.enabled boolean Required Whether the Worker should be available on the workers.dev subdomain.
body.previews_enabled boolean Optional Whether the Worker's Preview URLs should be available on the workers.dev subdomain.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Worker Tails — cloudflare.worker-tail-logs-list-tails

Get a list of tails currently deployed on a Worker.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start Worker Tail — cloudflare.worker-tail-logs-start-tail

Starts a tail that receives logs and exceptions from a Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker Tail — cloudflare.worker-tail-logs-delete-tail

Deletes a tail from a Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
path.id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01",
    "id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Script Usage Model — cloudflare.worker-script-fetch-usage-model

Fetches the usage model for a Worker script.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Worker Script Usage Model — cloudflare.worker-script-update-usage-model

Replaces the usage model for a Worker script. Requires a Workers Paid subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name"
body object Required
body.usage_model — Optional $ref: "#/definitions/workers_usage_model"
body.user_limits — Optional $ref: "#/definitions/workers_user_limits"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Versions — cloudflare.worker-versions-list-versions

List of Worker Versions. The first version in the list is the latest version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name-2"
query object Optional additionalProperties: false
query.deployable boolean Optional Only return versions that can be used in a deployment. Ignores pagination. default: false
query.page integer Optional Current page. default: 1
query.per_page integer Optional Items per-page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Script Version — cloudflare.worker-versions-get-version-detail

Retrieves detailed information about a specific version of a Worker script.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.script_name — Required $ref: "#/definitions/workers_script_name-2"
path.version_id — Required $ref: "#/definitions/workers_version_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_name": "this-is_my_script-01",
    "version_id": "bcf48806-b317-4351-9ee7-36e7d557d4de"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Environment Script Content — cloudflare.worker-environment-get-script-content

Get Worker script content for an environment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.service_name — Required $ref: "#/definitions/workers_service"
path.environment_name — Required $ref: "#/definitions/workers_environment"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "service_name": "my-worker",
    "environment_name": "production"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Environment Settings — cloudflare.worker-script-environment-get-settings

Get Worker script settings for an environment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.service_name — Required $ref: "#/definitions/workers_service"
path.environment_name — Required $ref: "#/definitions/workers_environment"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "service_name": "my-worker",
    "environment_name": "production"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Worker Environment Settings — cloudflare.worker-script-environment-patch-settings

Patch Worker script metadata for an environment, such as bindings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.service_name — Required $ref: "#/definitions/workers_service"
path.environment_name — Required $ref: "#/definitions/workers_environment"
body — Required $ref: "#/definitions/workers_script-settings-response"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "service_name": "my-worker",
    "environment_name": "production"
  },
  "body": {
    "success": true,
    "errors": [],
    "messages": [],
    "result": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Workers Subdomain — cloudflare.worker-subdomain-delete-subdomain

Deletes a Workers subdomain for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Workers Subdomain — cloudflare.worker-subdomain-get-subdomain

Returns a Workers subdomain for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Workers Subdomain — cloudflare.worker-subdomain-create-subdomain

Creates a Workers subdomain for an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
body — Required $ref: "#/definitions/workers_subdomain-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "subdomain": "my-subdomain"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Workers — cloudflare.listworkers

List all Workers for an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
query object Optional additionalProperties: false
query.page integer Optional Current page. default: 1; minimum: 1
query.per_page integer Optional Items per-page. default: 10; minimum: 1; maximum: 100
query.order_by string Optional Property to sort results by. enum: ["deployed_on","updated_on","created_on","name"]; default: "deployed_on"
query.order string Optional Sort direction. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Worker — cloudflare.createworker

Create a new Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/workers_Worker"
body object Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "example",
    "tags": [
      "my-team",
      "my-public-api"
    ],
    "subdomain": {},
    "observability": {},
    "logpush": false,
    "tail_consumers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker — cloudflare.deleteworker

Delete a Worker and all its associated resources (versions, deployments, etc.).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
query object Optional additionalProperties: false
query.force boolean Optional If true, delete the Worker even when other Workers still reference it. Service bindings in those Workers may be left broken. Durable Object namespaces implemented by the deleted Worker are deleted even if other Workers reference them.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker — cloudflare.getworker

Get details about a specific Worker.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Worker — cloudflare.editworker

Perform a partial update on a Worker, where omitted properties are left unchanged from their current values.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
body — Required
body — Required allOf[1]; $ref: "#/definitions/workers_Worker"
body object Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  },
  "body": {
    "name": "my-worker",
    "tags": [
      "my-team",
      "my-public-api"
    ],
    "subdomain": {},
    "observability": {},
    "logpush": false,
    "tail_consumers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Worker — cloudflare.updateworker

Perform a complete replacement of a Worker, where omitted properties are set to their default values. This is the exact same as the Create Worker endpoint, but operates on an existing Worker. To perform a partial update instead, use the Edit Worker endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
body — Required
body — Required allOf[1]; $ref: "#/definitions/workers_Worker"
body object Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  },
  "body": {
    "name": "example",
    "tags": [
      "my-team",
      "my-public-api"
    ],
    "subdomain": {},
    "observability": {},
    "logpush": false,
    "tail_consumers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Previews — cloudflare.workers.previews.list

List all Previews for a Worker.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
query object Optional additionalProperties: false
query.page integer Optional Current page. default: 1; minimum: 1
query.per_page integer Optional Items per-page. default: 10; minimum: 1; maximum: 100
query.order_by string Optional Property to sort results by. enum: ["deployed_on","updated_on","created_on","slug","name"]; default: "deployed_on"
query.order string Optional Sort direction. enum: ["asc","desc"]; default: "desc"
query.slug string Optional Partial-match filter on preview slug.
query.name string Optional Partial-match filter on preview name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Preview — cloudflare.workers.previews.create

Create a new Preview for a Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
query object Optional additionalProperties: false
query.ignore_defaults boolean Optional If true, preview defaults/base config from the parent Worker is ignored.
query.ignore_base_config boolean Optional If true, preview base config from the parent Worker is ignored.
body — Required
body — Required allOf[1]; $ref: "#/definitions/workers_Preview"
body object Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  },
  "body": {
    "name": "example",
    "tags": [
      "my-team",
      "my-preview"
    ],
    "observability": {},
    "logpush": false,
    "tail_consumers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Preview — cloudflare.workers.previews.delete

Delete a Preview.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
query object Optional additionalProperties: false
query.force boolean Optional If true, delete the Preview even when other Workers still reference it. Service bindings in those Workers may be left broken. Durable Object namespaces implemented by the deleted Preview are deleted even if other Workers reference them.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Preview — cloudflare.workers.previews.get

Get details about a specific Preview.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Preview — cloudflare.workers.previews.edit

Perform a partial update on a Preview, where omitted properties are left unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
body — Required
body — Required allOf[1]; $ref: "#/definitions/workers_Preview"
body object Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example"
  },
  "body": {
    "name": "feature/my-branch",
    "tags": [
      "my-team",
      "my-preview"
    ],
    "observability": {},
    "logpush": false,
    "tail_consumers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Preview — cloudflare.workers.previews.update

Perform a complete replacement of a Preview, where omitted properties are set to defaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
query object Optional additionalProperties: false
query.ignore_defaults boolean Optional If true, preview defaults/base config from the parent Worker is ignored.
query.ignore_base_config boolean Optional If true, preview base config from the parent Worker is ignored.
body — Required
body — Required allOf[1]; $ref: "#/definitions/workers_Preview"
body object Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example"
  },
  "body": {
    "name": "example",
    "tags": [
      "my-team",
      "my-preview"
    ],
    "observability": {},
    "logpush": false,
    "tail_consumers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Preview Deployments — cloudflare.workers.previews.deployments.list

List all deployments for a Preview.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
query object Optional additionalProperties: false
query.page integer Optional Current page. default: 1; minimum: 1
query.per_page integer Optional Items per-page. default: 10; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Preview Deployment — cloudflare.workers.previews.deployments.create

Create a new deployment for a Preview.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
query object Optional additionalProperties: false
query.ignore_defaults boolean Optional If true, preview defaults from the parent Worker are ignored.
body — Required $ref: "#/definitions/workers_PreviewDeploymentRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Latest Preview Deployment — cloudflare.workers.previews.deployments.patchlatest

Only /deployments/latest is supported. Creates a new preview deployment by applying a JSON Merge Patch (RFC 7396) to the latest deployment. Patching a specific deployment ID is not supported. Omitted fields are inherited from the latest deployment. Preview base config is used for the first deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
query object Optional additionalProperties: false
query.ignore_defaults boolean Optional If true, preview defaults from the parent Worker are ignored.
body — Optional $ref: "#/definitions/workers_PreviewDeploymentRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Preview Deployment — cloudflare.workers.previews.deployments.delete

Delete a preview deployment.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
path.deployment_id string Required Identifier for the deployment, which can be a UUID, a UUID prefix (minimum length 8), or the literal "latest" to operate on the most recently created deployment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example",
    "deployment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Preview Deployment — cloudflare.workers.previews.deployments.get

Get details about a specific preview deployment.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.preview_id string Required Identifier for the Preview, which can be ID, slug, or URL-encoded name.
path.deployment_id string Required Identifier for the deployment, which can be a UUID, a UUID prefix (minimum length 8), or the literal "latest" to operate on the most recently created deployment.
query object Optional additionalProperties: false
query.include string Optional Whether to include the modules property of the deployment in the response, which contains code and sourcemap content and may add several megabytes to the response size. enum: ["modules"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "preview_id": "example",
    "deployment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Worker Versions — cloudflare.listworkerversions

List all versions for a Worker.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
query object Optional additionalProperties: false
query.page integer Optional Current page. default: 1; minimum: 1
query.per_page integer Optional Items per-page. default: 10; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Worker Version — cloudflare.createworkerversion

Create a new version for a Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
query object Optional additionalProperties: false
query.deploy boolean Optional If true, a deployment will be created that sends 100% of traffic to the new version.
body — Required $ref: "#/definitions/workers_Version"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Latest Worker Version — cloudflare.getlatestworkerversion

Get details about the most recently created Worker version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
query object Optional additionalProperties: false
query.include string Optional Whether to include the modules property of the version in the response, which contains code and sourcemap content and may add several megabytes to the response size. enum: ["modules"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Latest Worker Version — cloudflare.patchlatestworkerversion

Only /versions/latest is supported. Creates a new Worker version by applying a JSON Merge Patch (RFC 7396) to the latest version. Patching a specific version ID is not supported. Omitted fields are inherited from the latest version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
query object Optional additionalProperties: false
query.deploy boolean Optional If true, a deployment will be created that sends 100% of traffic to the new version.
body — Optional
body — Optional allOf[1]; $ref: "#/definitions/workers_Version"
body object Optional allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker Version — cloudflare.deleteworkerversion

Delete a Worker version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.version_id string Required Identifier for the version, which can be a UUID, a UUID prefix (minimum length 8), or the literal "latest" to operate on the most recently created version.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "version_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Version — cloudflare.getworkerversion

Get details about a specific Worker version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/workers_identifier"
path.worker_id string Required Identifier for the Worker, which can be ID or name.
path.version_id string Required Identifier for the version, which can be a UUID, a UUID prefix (minimum length 8), or the literal "latest" to operate on the most recently created version.
query object Optional additionalProperties: false
query.include string Optional Whether to include the modules property of the version in the response, which contains code and sourcemap content and may add several megabytes to the response size. enum: ["modules"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "worker_id": "example",
    "version_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all Workflows — cloudflare.wor-list-workflows

Lists all workflows configured for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page number Optional default: 10; minimum: 1; maximum: 100
query.page number Optional default: 1; minimum: 1
query.search string Optional Allows filtering workflows` name. minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List concurrency keys — cloudflare.wor-list-concurrency-keys

Lists the account-scoped concurrency keys.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.per_page number Optional default: 10; minimum: 1; maximum: 100
query.page number Optional default: 1; minimum: 1
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a concurrency key — cloudflare.wor-create-concurrency-key

Creates an account-scoped concurrency key. Limits count steps still in flight from a previously deleted key of the same name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Required
body.limit integer Required Maximum number of steps that may concurrently hold this key. maximum: 9007199254740991; exclusiveMinimum: 0
body.name string Required Unique (per account) name of the concurrency key. Referenced by workflow steps via step config. minLength: 1; maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "name": "example",
    "limit": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a concurrency key — cloudflare.wor-delete-concurrency-key

Deletes a concurrency key. Fails while any workflow’s latest version references the key. The key disappears immediately, but steps already holding it keep their slots until they finish and still count against a key re-created with the same name.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id string Required Identifier of the concurrency key. format: "uuid"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get concurrency key details — cloudflare.wor-get-concurrency-key

Retrieves a concurrency key and the workflows whose latest version references it.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id string Required Identifier of the concurrency key. format: "uuid"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a concurrency key — cloudflare.wor-update-concurrency-key

Updates the limit of a concurrency key. Applies to instances that start after the change.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id string Required Identifier of the concurrency key. format: "uuid"
path.account_id string Required
body object Required
body.limit integer Required Maximum number of steps that may concurrently hold this key. maximum: 9007199254740991; exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  },
  "body": {
    "limit": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account settings — cloudflare.wor-get-workflow-settings

Retrieves account-level Workflows settings, such as the default instance retention.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update account settings — cloudflare.wor-update-workflow-settings

Updates only the account-level Workflows settings fields present in the request body.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body object Required
body.default_retention object Optional Default retention applied to instances of this version when they do not set their own retention.
body.default_retention.error_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body.default_retention.error_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body.default_retention.error_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"
body.default_retention.success_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body.default_retention.success_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body.default_retention.success_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deletes a Workflow — cloudflare.wor-delete-workflow

Deletes a Workflow. This only deletes the Workflow and does not delete or modify any Worker associated to this Workflow or bounded to it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workflow details — cloudflare.wor-get-workflow-details

Retrieves configuration and metadata for a specific workflow.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create/modify Workflow — cloudflare.wor-create-or-modify-workflow

Creates a new workflow or updates an existing workflow definition.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
body object Required
body.class_name string Required minLength: 1; maxLength: 255
body.concurrency object Optional
body.concurrency.limit integer Optional Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit. minimum: 1; maximum: 9007199254740991
body.default_retention object Optional Default retention applied to instances of this version when they do not set their own retention.
body.default_retention.error_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body.default_retention.error_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body.default_retention.error_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"
body.default_retention.success_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body.default_retention.success_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body.default_retention.success_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"
body.jurisdiction string Optional Jurisdiction where instances of this workflow run and store data. Can only be set when the workflow is created and cannot be changed afterwards; omit it to keep the existing jurisdiction. enum: ["eu","fedramp","us"]
body.limits object Optional
body.limits.steps integer Optional minimum: 1; maximum: 9007199254740991
body.schedules array Optional maxItems: 200
body.schedules[] object Optional
body.schedules[].cron string Required minLength: 1; maxLength: 256
body.script_name string Required minLength: 1; maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  },
  "body": {
    "script_name": "example",
    "class_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List of workflow instances — cloudflare.wor-list-workflow-instances

Lists all instances of a workflow with their execution status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
query object Optional additionalProperties: false
query.page number Optional Deprecated: use cursor for pagination instead. minimum: 1
query.per_page number Optional default: 50; minimum: 1; maximum: 100
query.cursor string Optional Opaque token for cursor-based pagination. Mutually exclusive with page.
query.direction string Optional Defines the direction for cursor-based pagination. enum: ["asc","desc"]
query.status string Optional enum: ["queued","running","paused","errored","terminated","complete","waitingForPause","waiting","rollingBack"]
query.date_start string Optional Accepts ISO 8601 with no timezone offsets and in UTC. format: "date-time"
query.date_end string Optional Accepts ISO 8601 with no timezone offsets and in UTC. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new workflow instance — cloudflare.wor-create-new-workflow-instance

Creates a new instance of a workflow, starting its execution.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
body object Required
body.instance_id string Optional The system reserves IDs that consist of the cf_ prefix and exactly 64 lowercase hexadecimal characters. minimum: 1; maximum: 100; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
body.instance_retention object Optional
body.instance_retention.error_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body.instance_retention.error_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body.instance_retention.error_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"
body.instance_retention.success_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body.instance_retention.success_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body.instance_retention.success_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"
body.location_hint string Optional enum: ["wnam","weur","enam","eeur","apac","apac-ne","apac-se","oc","sam","afr","me"]
body.params string Optional JSON-encoded event payload passed into the new instance.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch create new Workflow instances — cloudflare.wor-batch-create-workflow-instance

Creates multiple workflow instances in a single batch operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
body array Required minItems: 1; maxItems: 100
body[] object Optional
body[].instance_id string Optional The system reserves IDs that consist of the cf_ prefix and exactly 64 lowercase hexadecimal characters. minimum: 1; maximum: 100; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
body[].instance_retention object Optional
body[].instance_retention.error_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body[].instance_retention.error_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body[].instance_retention.error_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"
body[].instance_retention.success_retention — Optional Specifies the duration in milliseconds or as a string like '5 minutes'.
body[].instance_retention.success_retention integer Optional Specifies the duration in milliseconds. anyOf[1]
body[].instance_retention.success_retention string Optional anyOf[2]; pattern: "^(\\d+)\\s+(second|minute|hour|day|week|month|year)s?$"
body[].location_hint string Optional enum: ["wnam","weur","enam","eeur","apac","apac-ne","apac-se","oc","sam","afr","me"]
body[].params string Optional JSON-encoded event payload passed into the new instance.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  },
  "body": [
    {}
  ]
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch delete instances of a workflow — cloudflare.wor-batch-delete-workflow-instances

Deletes multiple workflow instances in a single batch operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
body object Required
body.instances array Required minItems: 1; maxItems: 100
body.instances[] string Optional Instance identifier. Accepts user-created IDs (^[a-zA-Z0-9_][a-zA-Z0-9-_]*$, maximum 100 characters) and system-generated IDs that consist of a cf_ or - prefix and exactly 64 lowercase hexadecimal characters. minLength: 1; maxLength: 100; pattern: "^(-[0-9a-f]{64}|[a-zA-Z0-9_][a-zA-Z0-9-_]*)$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  },
  "body": {
    "instances": [
      "example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch terminate instances of a workflow — cloudflare.wor-batch-terminate-workflow-instances

Performs a batch termination of multiple workflow instances.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
body array Required minItems: 1; maxItems: 100
body[] string Optional minLength: 1; maxLength: 100; pattern: "^(-[0-9a-f]{64}|[a-zA-Z0-9_][a-zA-Z0-9-_]*)$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  },
  "body": [
    "example"
  ]
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get status of the job responsible for terminate all instances of a workflow — cloudflare.wor-status-terminate-workflow-instances

Gets the status of a bulk workflow instance termination job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a workflow instance — cloudflare.wor-delete-workflow-instance

Deletes a workflow instance and its stored state.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.instance_id string Required Instance identifier. User-created instances match ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. minLength: 1; maxLength: 271
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "instance_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get logs and status from instance — cloudflare.wor-describe-workflow-instance

Retrieves logs and execution status for a specific workflow instance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.instance_id string Required Instance identifier. User-created instances match ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. minLength: 1; maxLength: 271
path.account_id string Required
query object Optional additionalProperties: false
query.simple string Optional When true, omits step details and returns only metadata with step_count. enum: ["true","false"]; default: "false"
query.order string Optional Step ordering: "asc" (default, oldest first) or "desc" (newest first). enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "instance_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Send event to instance — cloudflare.wor-send-event-workflow-instance

Sends an event to a running workflow instance to trigger state transitions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.instance_id string Required Instance identifier. User-created instances match ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. minLength: 1; maxLength: 271
path.event_type string Required minLength: 1; maxLength: 100; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
body object Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "instance_id": "example",
    "event_type": "example",
    "account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change status of instance — cloudflare.wor-change-status-workflow-instance

Changes the execution status of a workflow instance (e.g., pause, resume, terminate).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.instance_id string Required Instance identifier. User-created instances match ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. minLength: 1; maxLength: 271
path.account_id string Required
body — Required
body object Required oneOf[1]
body.status string Required oneOf[1]; enum: ["pause"]
body object Required oneOf[2]
body.status string Required oneOf[2]; enum: ["resume"]
body object Required oneOf[3]
body.rollback boolean Optional Run rollback before terminating. oneOf[3]
body.status string Required oneOf[3]; enum: ["terminate"]
body object Required oneOf[4]
body.from object Optional Step to restart from. oneOf[4]
body.from.count integer Optional oneOf[4]; maximum: 9007199254740991; exclusiveMinimum: 0
body.from.name string Required oneOf[4]; minLength: 1; maxLength: 256
body.from.type string Optional oneOf[4]; enum: ["do","sleep","waitForEvent"]
body.status string Required oneOf[4]; enum: ["restart"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "instance_id": "example",
    "account_id": "example"
  },
  "body": {
    "status": "pause"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get full step output from instance — cloudflare.wor-get-workflow-instance-step

Retrieves the full, untruncated output for a specific step on a workflow instance. Returns a flat status-shaped JSON body with step status ('running' | 'waiting' | 'complete' | 'errored'), error (nullable), and output (the step value, or null while running/waiting/errored). When the step returned a ReadableStream from step.do, the response is served as 'application/octet-stream' with the raw bytes as the body instead of JSON. A status='running' response with non-null error indicates the step is currently retrying after a prior attempt failed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.instance_id string Required Instance identifier. User-created instances match ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. minLength: 1; maxLength: 271
path.account_id string Required
query object Required additionalProperties: false
query.name string Required Exact step name from the instance logs response, including the generated counter suffix. minLength: 1
query.type string Required Step type to disambiguate step.do and waitForEvent entries that share the same name. enum: ["step","waitForEvent"]
query.attempt integer Optional Specific attempt number to retrieve output or error for. maximum: 9007199254740991; exclusiveMinimum: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "instance_id": "example",
    "account_id": "example"
  },
  "query": {
    "name": "example",
    "type": "step"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a workflow instance event subscription token — cloudflare.wor-create-workflow-instance-subscription-token

Creates a short-lived token for connecting to the workflow instance event WebSocket.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.instance_id string Required Instance identifier. User-created instances match ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. minLength: 1; maxLength: 271
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "instance_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deployed Workflow versions — cloudflare.wor-list-workflow-versions

Lists all deployed versions of a workflow.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.account_id string Required
query object Optional additionalProperties: false
query.per_page number Optional default: 50; minimum: 1; maximum: 100
query.page number Optional default: 1; minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workflow version details — cloudflare.wor-describe-workflow-versions

Retrieves details for a specific deployed workflow version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.version_id string Required format: "uuid"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "version_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workflow version dag — cloudflare.wor-describe-workflow-versions-dag

Retrieves the directed acyclic graph (DAG) representation of a workflow version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.version_id string Required format: "uuid"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "version_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workflow version graph — cloudflare.wor-describe-workflow-versions-graph

Retrieves the graph visualization of a workflow version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.workflow_name string Required minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_][a-zA-Z0-9-_]*$"
path.version_id string Required format: "uuid"
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "workflow_name": "example",
    "version_id": "00000000-0000-4000-8000-000000000000",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zero Trust Connectivity Settings — cloudflare.zero-trust-accounts-get-connectivity-settings

Gets the Zero Trust Connectivity Settings for the given account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates the Zero Trust Connectivity Settings — cloudflare.zero-trust-accounts-patch-connectivity-settings

Updates the Zero Trust Connectivity Settings for the given account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.icmp_proxy_enabled — Optional $ref: "#/definitions/tunnel_icmp_proxy_enabled"
body.offramp_warp_enabled — Optional $ref: "#/definitions/tunnel_offramp_warp_enabled"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List hostname routes — cloudflare.zero-trust-networks-route-hostname-list

Lists and filters hostname routes in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.id — Optional $ref: "#/definitions/tunnel_hostname_route_id"
query.hostname — Optional If set, only list hostname routes that contain a substring of the given value, the filter is case-insensitive. $ref: "#/definitions/tunnel_hostname"
query.tunnel_id — Optional If set, only list hostname routes that point to a specific tunnel. $ref: "#/definitions/tunnel_tunnel_id-3"
query.comment — Optional $ref: "#/definitions/tunnel_hostname_query_comment"
query.existed_at — Optional $ref: "#/definitions/tunnel_existed_at"
query.is_deleted boolean Optional If true, only return deleted hostname routes. If false, exclude deleted hostname routes. default: false
query.per_page — Optional $ref: "#/definitions/tunnel_per_page"
query.page — Optional $ref: "#/definitions/tunnel_page_number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create hostname route — cloudflare.zero-trust-networks-route-hostname-create

Create a hostname route.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_hostname_comment"
body.hostname — Optional $ref: "#/definitions/tunnel_hostname"
body.tunnel_id — Optional $ref: "#/definitions/tunnel_tunnel_id-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete hostname route — cloudflare.zero-trust-networks-route-hostname-delete

Delete a hostname route.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.hostname_route_id — Required $ref: "#/definitions/tunnel_hostname_route_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "hostname_route_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get hostname route — cloudflare.zero-trust-networks-route-hostname-get

Get a hostname route.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.hostname_route_id — Required $ref: "#/definitions/tunnel_hostname_route_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "hostname_route_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update hostname route — cloudflare.zero-trust-networks-route-hostname-update

Updates a hostname route.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.hostname_route_id — Required $ref: "#/definitions/tunnel_hostname_route_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_hostname_comment"
body.hostname — Optional $ref: "#/definitions/tunnel_hostname"
body.tunnel_id — Optional $ref: "#/definitions/tunnel_tunnel_id-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "hostname_route_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Subnets — cloudflare.zero-trust-networks-subnets-list

Lists and filters subnets in an account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
query object Optional additionalProperties: false
query.name — Optional If set, only list subnets with the given name $ref: "#/definitions/tunnel_subnet_query_name"
query.comment — Optional $ref: "#/definitions/tunnel_subnet_query_comment"
query.network — Optional If set, only list the subnet whose network exactly matches the given CIDR.
query.network — Optional allOf[1]; $ref: "#/definitions/tunnel_ip_network_encoded"
query.existed_at — Optional $ref: "#/definitions/tunnel_existed_at"
query.address_family — Optional If set, only include subnets in the given address family - v4 or v6 $ref: "#/definitions/tunnel_address_family"
query.is_default_network boolean Optional If true, only include default subnets. If false, exclude default subnets subnets. If not set, all subnets will be included.
query.is_deleted boolean Optional If true, only include deleted subnets. If false, exclude deleted subnets. If not set, all subnets will be included.
query.sort_order string Optional Sort order of the results. asc means oldest to newest, desc means newest to oldest. If not set, they will not be in any particular order. enum: ["asc","desc"]
query.subnet_types string Optional If set, the types of subnets to include, separated by comma. enum: ["cloudflare_source","initial_resolved_ip","warp"]
query.per_page — Optional $ref: "#/definitions/tunnel_per_page"
query.page — Optional $ref: "#/definitions/tunnel_page_number"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cloudflare Source Subnet — cloudflare.zero-trust-networks-subnet-get-cloudflare-source

Returns the account's default Cloudflare Source subnet for the given address family.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.address_family — Required $ref: "#/definitions/tunnel_address_family"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "address_family": "v4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Cloudflare Source Subnet — cloudflare.zero-trust-networks-subnet-update-cloudflare-source

Updates the Cloudflare Source subnet of the given address family

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.address_family — Required $ref: "#/definitions/tunnel_address_family"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_subnet_comment"
body.name — Optional $ref: "#/definitions/tunnel_subnet_name"
body.network — Optional $ref: "#/definitions/tunnel_subnet_ip_network"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "address_family": "v4"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Initial Resolved IP Subnet — cloudflare.zero-trust-networks-subnet-get-initial-resolved-ip

Returns the account's default Initial Resolved IP Subnet for the given address family.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.address_family — Required $ref: "#/definitions/tunnel_address_family"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "address_family": "v4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Initial Resolved IP Subnet — cloudflare.zero-trust-networks-subnet-update-initial-resolved-ip

Updates the CIDR for the account's default Initial Resolved IP Subnet of the given address family. The new CIDR must not conflict with existing private routes in the account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.address_family — Required $ref: "#/definitions/tunnel_address_family"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_subnet_comment"
body.name — Optional $ref: "#/definitions/tunnel_subnet_name"
body.network — Optional $ref: "#/definitions/tunnel_subnet_ip_network"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "address_family": "v4"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create WARP IP subnet — cloudflare.zero-trust-networks-subnet-create-warp

Create a WARP IP assignment subnet. Currently, only IPv4 subnets can be created.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_subnet_comment"
body.is_default_network — Optional $ref: "#/definitions/tunnel_subnet_is_default_network"
body.name — Required $ref: "#/definitions/tunnel_subnet_name"
body.network — Required $ref: "#/definitions/tunnel_subnet_ip_network"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "IPv4 Cloudflare Source IPs",
    "network": "100.64.0.0/12"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete WARP IP subnet — cloudflare.zero-trust-networks-subnet-delete-warp

Delete a WARP IP assignment subnet. This operation is idempotent - deleting an already-deleted or non-existent subnet will return success with a null result.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.subnet_id — Required $ref: "#/definitions/tunnel_subnet_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "subnet_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get WARP IP subnet — cloudflare.zero-trust-networks-subnet-get-warp

Get a WARP IP assignment subnet.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.subnet_id — Required $ref: "#/definitions/tunnel_subnet_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "subnet_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update WARP IP subnet — cloudflare.zero-trust-networks-subnet-update-warp

Updates a WARP IP assignment subnet.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id — Required $ref: "#/definitions/tunnel_account_id"
path.subnet_id — Required $ref: "#/definitions/tunnel_subnet_id"
body object Required
body.comment — Optional $ref: "#/definitions/tunnel_subnet_comment"
body.is_default_network — Optional $ref: "#/definitions/tunnel_subnet_is_default_network"
body.name — Optional $ref: "#/definitions/tunnel_subnet_name"
body.network — Optional $ref: "#/definitions/tunnel_subnet_ip_network"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "699d98642c564d2e855e9661899b7252",
    "subnet_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all behaviors and associated configuration — cloudflare.dlp-risk-score-behaviors-get

Retrieves configured risk score behaviors that define how user actions affect their overall risk score.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update configuration for risk behaviors — cloudflare.dlp-risk-score-behaviors-put

Updates risk score behavior configurations, defining weights and thresholds for risk calculation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Account ID.
body — Required $ref: "#/definitions/dlp_UpdateBehaviors"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "behaviors": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all risk score integrations for the account. — cloudflare.dlp-zt-risk-score-integration-list

Lists all configured Zero Trust risk score integrations for the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create new risk score integration. — cloudflare.dlp-zt-risk-score-integration-create

Creates a new Zero Trust risk score integration, connecting external risk signals to Cloudflare's risk scoring system.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Required $ref: "#/definitions/dlp_CreateIntegrationBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  },
  "body": {
    "integration_type": "Okta",
    "tenant_url": "https://example.com/"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get risk score integration by reference id. — cloudflare.dlp-zt-risk-score-integration-get-by-reference-id

Retrieves a Zero Trust risk score integration using its external reference ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.reference_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "reference_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a risk score integration. — cloudflare.dlp-zt-risk-score-integration-delete

Removes a Zero Trust risk score integration, disconnecting the external risk signal source.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.integration_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "integration_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get risk score integration by id. — cloudflare.dlp-zt-risk-score-integration-get

Gets a Zero Trust risk score integration by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.integration_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "integration_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a risk score integration. — cloudflare.dlp-zt-risk-score-integration-update

Overwrite the reference_id, tenant_url, and active values with the ones provided.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.integration_id string Required format: "uuid"
body — Required $ref: "#/definitions/dlp_UpdateIntegrationBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "integration_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "tenant_url": "https://example.com/",
    "active": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get risk score info for all users in the account — cloudflare.dlp-risk-score-summary-get

Gets an aggregate summary of risk scores across the account, including distribution and trends.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get risk event/score information for a specific user — cloudflare.dlp-risk-score-summary-get-for-user

Retrieves the detailed risk score breakdown for a specific user, including contributing factors.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.user_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "user_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Clear the risk score for a particular user — cloudflare.dlp-risk-score-reset-post

Resets risk scores for specified users, clearing their accumulated risk history.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
path.user_id string Required format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "user_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query analytics datasets — cloudflare.sql-api-query-get

Executes a SQL query against the analytics datasets available to the caller. SQL placeholders can be bound with query parameters named param_<name>, such as param_status=404 for $status. A trailing FORMAT JSON, FORMAT JSONEachRow, FORMAT TabSeparated, or FORMAT TSV is supported for all datasets. Without FORMAT, each backend retains its existing default JSON response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.query string Required SQL query to execute. A trailing FORMAT selects JSON, JSONEachRow, TabSeparated, or TSV output on any dataset.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "query": "SELECT edgeResponseStatus FROM events.httpRequests WHERE accountTag = '0123456789abcdef0123456789abcdef' AND datetime > '2026-01-01' LIMIT 10"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Query analytics datasets — cloudflare.sql-api-query-post

Executes a SQL query against the analytics datasets available to the caller. Send either raw SQL or a JSON object containing the query and optional positional or named parameters, time range, and account or zone scope. Raw SQL placeholders can also be bound with query parameters named param_<name>. A trailing FORMAT JSON, FORMAT JSONEachRow, FORMAT TabSeparated, or FORMAT TSV is supported for all datasets. Without FORMAT, each backend retains its existing default JSON response.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/analytics-sql_SqlQueryRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "params": {
      "status": 404
    },
    "query": "SELECT edgeResponseStatus FROM events.httpRequests WHERE edgeResponseStatus = $status LIMIT 10",
    "scope": {
      "accountTag": "0123456789abcdef0123456789abcdef"
    },
    "time_range": {
      "end": "2026-01-02T00:00:00Z",
      "start": "2026-01-01T00:00:00Z"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List available analytics datasets — cloudflare.sql-api-introspection

Returns the analytics dataset catalogue. By default, the response contains dataset names, titles, categories, descriptions, kinds, and hidden flags. Set include_columns to include each dataset's column names, descriptions, data types, and hidden flags. The caller must have Account Analytics Read permission on the account identified by account_tag. Dataset names, descriptions, and columns are the same for every authorized account. When include_custom_attributes or include_attributes is set, the response also includes attribute names and types discovered from that account's own data, which legitimately differs per caller. attributes is a replacement for custom_attributes that will eventually be removed; until then, set either flag independently to receive the corresponding field. hidden marks catalogue entries a client should de-emphasise. It has no effect on access: hidden datasets and columns are returned here and remain fully queryable.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.account_tag string Required Account whose available analytics datasets are returned. pattern: "^[0-9a-f]{32}$"
query.include_columns boolean Optional Include column metadata for each returned dataset. default: false
query.include_custom_attributes boolean Optional Include a capped set of custom attribute names and types observed during the preceding seven days, as custom_attributes. Requires a nonempty dataset_name. Deprecated in favor of include_attributes. default: false
query.include_attributes boolean Optional Include a capped set of attribute names and types observed during the preceding seven days, as attributes. Requires a nonempty dataset_name. Replaces include_custom_attributes, which is deprecated. default: false
query.include_wae boolean Optional Include Workers Analytics Engine datasets, which are discovered from the account's own data. Set to false to return only datasets described from the static catalogue, which avoids that lookup. default: true
query.include_lex boolean Optional Include Log Explorer datasets, which are listed only where the account has them. Set to false to return only datasets described from the static catalogue, which avoids that lookup. default: true
query.dataset_name string Optional Return only the dataset with this exact name. An empty value is treated as if the parameter had been omitted, and does not filter the catalogue. A name that matches no dataset in this deployment's catalogue is rejected with 422; a dataset that exists but is not describable here is rejected identically, so the two cases cannot be told apart. A Workers Analytics Engine dataset is named in full, as events.analyticsEngine.&lt;dataset_name&gt;; the namespace on its own returns every such dataset the account has. A dataset_name the account does not have is rejected with 422 like any other unknown name.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "account_tag": "0123456789abcdef0123456789abcdef"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate Billing Address — cloudflare.billing-validate-address

Validates a billing address and returns validated address suggestions. Authentication is not enforced to support pre-signup address validation flows, so credentials are accepted but not required.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/bill-subs-api_address_validation_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Rate Plan by Public Key — cloudflare.billing-get-rate-plan

Gets a rate plan's details by its public key (e.g., 'teams_free', 'cf_pro_20_20'). This is a public catalog endpoint, so authentication is not enforced and credentials are accepted but not required.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.public_key string Required The public key identifier for the rate plan.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "public_key": "teams_free"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Certificates — cloudflare.origin-ca-list-certificates

List all existing Origin CA certificates for a given zone. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint (see above).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of records per page. default: 20; minimum: 5; maximum: 50
query.limit integer Optional Limit to the number of records returned.
query.offset integer Optional Offset the results.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Certificate — cloudflare.origin-ca-create-certificate

Create an Origin CA certificate. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint (see above).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.csr — Required $ref: "#/definitions/tls-certificates-and-hostnames_csr"
body.hostnames — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostnames"
body.request_type — Required $ref: "#/definitions/tls-certificates-and-hostnames_request_type"
body.requested_validity — Optional $ref: "#/definitions/tls-certificates-and-hostnames_requested_validity"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "hostnames": [
      "example.com",
      "*.example.com",
      "sub.example.com"
    ],
    "request_type": "origin-rsa",
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke Certificate — cloudflare.origin-ca-revoke-certificate

Revoke an existing Origin CA certificate by its serial number. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint (see above).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_origin_ca_certificate_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "328578533902268680212849205732770752308931942346"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Certificate — cloudflare.origin-ca-get-certificate

Get an existing Origin CA certificate by its serial number. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint (see above).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_origin_ca_certificate_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "328578533902268680212849205732770752308931942346"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List category APIs — cloudflare.cws-list-category-apis

Returns distinct active API names across every application or beneath an exact application name.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.cursor string Optional Pagination cursor from previous response
query.per_page integer Optional Number of items per page (1-100, default 20) default: 20; minimum: 1; maximum: 100
query.application string Optional Exact case-sensitive application name. Omit to search every application. minLength: 1
query.name string Optional Case-insensitive substring search over API names.
query.variants boolean Optional Include the routing identities represented by each API name. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List category applications — cloudflare.cws-list-category-applications

Returns active applications and their stable keys.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.cursor string Optional Pagination cursor from previous response
query.per_page integer Optional Number of items per page (1-100, default 20) default: 20; minimum: 1; maximum: 100
query.name string Optional Case-insensitive substring search over application names.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List application versions — cloudflare.cws-list-category-application-versions

Lists immutable category bundle versions for an application.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.cursor string Optional Pagination cursor from previous response
query.per_page integer Optional Number of items per page (1-100, default 20) default: 20; minimum: 1; maximum: 100
path object Required additionalProperties: false
path.application_key string Required Stable application key. minLength: 1; maxLength: 255; pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "application_key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the latest application version — cloudflare.cws-get-latest-category-application-version

Returns the latest immutable category bundle and supports conditional retrieval with If-None-Match.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.application_key string Required Stable application key. minLength: 1; maxLength: 255; pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$"
headers object Optional additionalProperties: false
headers.If-None-Match string Optional Previously received bundle ETag. A match returns 304 without a response body.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "application_key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an application version — cloudflare.cws-get-category-application-version

Returns a pinned immutable category bundle version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.application_key string Required Stable application key. minLength: 1; maxLength: 255; pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$"
path.version_tag string Required Immutable application version identifier. minLength: 1; maxLength: 255; pattern: "^[A-Za-z0-9][A-Za-z0-9._~-]*$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "application_key": "example",
    "version_tag": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List category operations — cloudflare.cws-list-category-operations

Returns distinct active operation names across every path and supports independent exact application and API ancestor filters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.cursor string Optional Pagination cursor from previous response
query.per_page integer Optional Number of items per page (1-100, default 20) default: 20; minimum: 1; maximum: 100
query.application string Optional Exact case-sensitive application ancestor name. Omit to search every application. minLength: 1
query.api string Optional Exact case-sensitive API ancestor name. Omit to search every API. minLength: 1
query.name string Optional Case-insensitive substring search over operation names.
query.variants boolean Optional Include the routing identities represented by each operation name. Defaults to false.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get filter fields — cloudflare.cws-get-filter-schema

Returns separate policy and workload field catalogs with metadata and UI hints for building filter expressions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cloudflare/JD Cloud IP Details — cloudflare.cloudflare-ips-cloudflare-ip-details

Get IPs used on the Cloudflare/JD Cloud network, see https://www.cloudflare.com/ips for Cloudflare IPs or https://developers.cloudflare.com/china-network/reference/infrastructure/ for JD Cloud IPs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.networks string Optional Specified as jdcloud to list IPs used by JD Cloud data centers.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Memberships — cloudflare.user--s-account-memberships-list-memberships

List memberships of accounts the user can access.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.account.name — Optional $ref: "#/definitions/iam_properties-name"
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of memberships per page. default: 20; minimum: 5; maximum: 50
query.order string Optional Field to order memberships by. enum: ["id","account.name","status"]
query.direction string Optional Direction to order memberships. enum: ["asc","desc"]
query.name — Optional $ref: "#/definitions/iam_properties-name"
query.status string Optional Status of this membership. enum: ["accepted","pending","rejected"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Membership — cloudflare.user--s-account-memberships-delete-membership

Remove the associated member from an account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.membership_id — Required $ref: "#/definitions/iam_membership_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "membership_id": "4536bcfad5faccb111b47003c79917fa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Membership Details — cloudflare.user--s-account-memberships-membership-details

Get a specific membership.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.membership_id — Required $ref: "#/definitions/iam_membership_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "membership_id": "4536bcfad5faccb111b47003c79917fa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Membership — cloudflare.user--s-account-memberships-update-membership

Accept or reject this account invitation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.membership_id — Required $ref: "#/definitions/iam_membership_components-schemas-identifier"
body object Required
body.status string Required Whether to accept or reject this account invitation. enum: ["accepted","rejected"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "membership_id": "4536bcfad5faccb111b47003c79917fa"
  },
  "body": {
    "status": "accepted"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List OAuth Scopes — cloudflare.oauth-scopes-list

List all available OAuth scopes. This endpoint requires authentication but has no authorization role requirements.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organizations the user has access to — cloudflare.organization_listorganizations

Retrieve a list of organizations a particular user has access to. At most one of containing.account, containing.user, or containing.organization may be provided.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.id array Optional Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.
query.id[] — Optional $ref: "#/definitions/organizations-api_OrganizationID"
query.name string Optional (case-sensitive) Filter the list of organizations to where the name is equal to a particular string.
query.name.startsWith string Optional (case-insensitive) Filter the list of organizations to where the name starts with a particular string.
query.name.endsWith string Optional (case-insensitive) Filter the list of organizations to where the name ends with a particular string.
query.name.contains string Optional (case-insensitive) Filter the list of organizations to where the name contains a particular string.
query.containing.account string Optional Filter the list of organizations to the ones that contain this particular account.
query.containing.user string Optional Filter the list of organizations to the ones that contain this particular user. IMPORTANT: Just because an organization "contains" a user is not a representation of any authorization or privilege to manage any resources therein. An organization "containing" a user simply means the user is managed by that organization.
query.containing.organization string Optional Filter the list of organizations to the ones that contain this particular organization.
query.parent.id — Optional Filter the list of organizations to the ones that are a sub-organization of the specified organization. "null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)."
query.parent.id — Optional anyOf[1]; $ref: "#/definitions/organizations-api_OrganizationID"
query.parent.id string Optional anyOf[2]; enum: ["null"]
query.member.email string Optional Filter organizations to those where the given user, by email, is an active member of that exact organization. This does not include hierarchy-derived access.
query.order_by string Optional Field to order results by. Currently supported values: name. When not specified, results are ordered by hierarchy. enum: ["name"]
query.direction string Optional Sort direction for the order_by field. Defaults to asc when order_by is specified. enum: ["asc","desc"]
query.page_token string Optional An opaque token returned from the last list response that when provided will retrieve the next page. Parameters used to filter the retrieved list must remain in subsequent requests with a page token.
query.page_size integer Optional The amount of items to return. Defaults to 10. minimum: 0; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create organization — cloudflare.organizations_createuserorganization

Create a new organization for a user. Sub-organization creation availability depends on the organization's capabilities. The optional profile object accepts partial profile details; its individual fields are not required. Organization names are limited to 65 UTF-8 bytes. Each profile field is limited to 1,000 UTF-8 bytes, and a non-empty business email must be valid. At least one of business name, address, phone, or email must be non-empty to persist a profile.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/organizations-api_CreateOrganizationRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete organization — cloudflare.organizations_delete

Delete an organization. It must not contain active sub-organizations or accounts. A root organization must also have no active managed users. Sub-organization deletion availability depends on the organization's capabilities.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required The ID of the organization to delete. $ref: "#/definitions/organizations-api_OrganizationID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get organization — cloudflare.organizations_retrieve

Retrieve the details of a certain organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required The ID of the organization to retrieve. $ref: "#/definitions/organizations-api_OrganizationID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update organization — cloudflare.organizations_modify

Update an organization's name. Supplying parent_id verifies the current parent; this endpoint cannot move an organization. Organization names are limited to 65 UTF-8 bytes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required The ID of the organization to modify. $ref: "#/definitions/organizations-api_OrganizationID"
body — Required $ref: "#/definitions/organizations-api_ModifyOrganizationRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization accounts — cloudflare.organizations_getaccounts

Retrieve the accounts immediately attached to a specific organization. Accounts attached to sub-organizations are not included. Use page_token and page_size for cursor pagination, or provide page and per_page together for legacy offset pagination. Cursor pagination takes precedence when requested. The default response uses Account fields; Accept: application/json; legacy=true requests the LegacyAccount representation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.Accept string Optional Request application/json; legacy=true for the LegacyAccount representation.
path object Required additionalProperties: false
path.organization_id — Required The ID of the organization to retrieve a list of accounts for. $ref: "#/definitions/organizations-api_OrganizationID"
query object Optional additionalProperties: false
query.account_pubname string Optional (case-sensitive) Filter the list of accounts to where the account_pubname is equal to a particular string.
query.account_pubname.startsWith string Optional (case-insensitive) Filter the list of accounts to where the account_pubname starts with a particular string.
query.account_pubname.endsWith string Optional (case-insensitive) Filter the list of accounts to where the account_pubname ends with a particular string.
query.account_pubname.contains string Optional (case-insensitive) Filter the list of accounts to where the account_pubname contains a particular string.
query.name string Optional (case-sensitive) Filter the list of accounts to where the name is equal to a particular string. At most one of name, name.startsWith, name.endsWith, or name.contains may be supplied per request.
query.name.startsWith string Optional (case-insensitive) Filter the list of accounts to where the name starts with a particular string.
query.name.endsWith string Optional (case-insensitive) Filter the list of accounts to where the name ends with a particular string.
query.name.contains string Optional (case-insensitive) Filter the list of accounts to where the name contains a particular string.
query.status string Optional Filter accounts by lifecycle status. Defaults to active. enum: ["active","deleted"]
query.order_by string Optional Field to order results by. Currently supported values: account_name. enum: ["account_name"]
query.direction string Optional Sort direction for the order_by field. Valid values: asc, desc. Defaults to asc when order_by is specified. enum: ["asc","desc"]
query.include_tags boolean Optional Include Account tags from the resource tag mirror. Omit this parameter to preserve the existing Account response shape.
query.include_total boolean Optional Whether to calculate and return the exact result_info.total_size for cursor pagination. Defaults to true. When false, total_size is omitted. page_size and include_total may change between pages; next_page_token remains the authoritative continuation signal. Legacy page/per_page requests always calculate total_count. default: true
query.page integer Optional Legacy offset page number. Must be provided with per_page. Values below 1 are treated as 1. Cursor pagination takes precedence when requested.
query.per_page integer Optional Legacy offset page size. Must be provided with page. Values are clamped to the range 1-100. Cursor pagination takes precedence when requested.
query.page_token string Optional An opaque token returned from the last list response that when provided will retrieve the next page. Parameters used to filter the retrieved list must remain in subsequent requests with a page token.
query.page_size integer Optional The amount of items to return. Defaults to 10. minimum: 0; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Organization Usage (Version 2, Alpha, Restricted) — cloudflare.billable-usage-v2-get-organization-usage

Returns cost and usage data for all accounts within an organization, aligned with the FinOps FOCUS v1.3 Cost and Usage dataset specification.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required Identifies the Cloudflare organization. $ref: "#/definitions/billable-usage-api_identifier"
query object Optional additionalProperties: false
query.from string Optional Start date for the usage query (ISO 8601). Required if to is set. When omitted along with to, defaults to the start of the current month. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. format: "date"
query.to string Optional End date for the usage query (ISO 8601). Required if from is set. When omitted along with from, defaults to today. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Handle organization invite — cloudflare.organizations_handleorganizationinvite

Accept or reject an invitation to a specific organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required The ID of the organization associated with the invitation. $ref: "#/definitions/organizations-api_OrganizationID"
path.member_code string Required The invitation code to accept or reject.
body — Required $ref: "#/definitions/organizations-api_HandleOrganizationInviteRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
    "member_code": "example"
  },
  "body": {
    "status": "accept"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get organization audit logs (Version 2) — cloudflare.audit-logs-v2-get-organization-audit-logs

Gets a list of audit logs for an organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id string Required The unique id that identifies the organization.
query object Required additionalProperties: false
query.action_result array Optional Filters by whether the action was successful or not.
query.action_result[] string Optional enum: ["success","failure"]
query.action_type array Optional Filters by the action type.
query.action_type[] string Optional enum: ["create","delete","view","update"]
query.actor_context array Optional Filters by the actor context. - api: The action was performed through the API. The specific credential type was not recorded. - api_key: The action was authenticated with a Cloudflare Global API Key. - api_token: The action was authenticated with an API token. - dash: The action was performed through the Cloudflare dashboard. - oauth: The action was authenticated with an OAuth token. - origin_ca_key: The action was authenticated with an Origin CA key.
query.actor_context[] string Optional enum: ["api","api_key","api_token","dash","oauth","origin_ca_key"]
query.actor_email array Optional Filters by the actor's email address.
query.actor_email[] string Optional format: "email"
query.actor_id array Optional Filters by the actor's user ID.
query.actor_id[] string Optional
query.actor_ip_address array Optional The IP address where the action was initiated.
query.actor_ip_address[] string Optional
query.actor_token_id array Optional Filters by the API token ID when the actor context is an api_token or oauth.
query.actor_token_id[] string Optional
query.actor_token_name array Optional Filters by the API token name when the actor context is an api_token or oauth.
query.actor_token_name[] string Optional
query.actor_type array Optional Filters by the actor type.
query.actor_type[] string Optional enum: ["cloudflare_admin","system","user"]
query.id array Optional Finds a specific log by its ID.
query.id[] string Optional
query.raw_cf_ray_id array Optional Filters by the response CF Ray ID.
query.raw_cf_ray_id[] string Optional
query.raw_method array Optional The HTTP method for the API call.
query.raw_method[] string Optional
query.raw_status_code array Optional The response status code that was returned.
query.raw_status_code[] integer Optional
query.raw_uri array Optional Filters by the request URI.
query.raw_uri[] string Optional
query.resource_id array Optional Filters by the resource ID.
query.resource_id[] string Optional
query.resource_product array Optional Filters audit logs by the Cloudflare product associated with the changed resource.
query.resource_product[] string Optional
query.resource_type array Optional Filters audit logs based on the unique type of resource changed by the action.
query.resource_type[] string Optional
query.resource_scope array Optional Filters by the resource scope, specifying whether the resource is associated with an organization.
query.resource_scope[] string Optional enum: ["organizations"]
query.action_result.not array Optional Filters out audit logs by whether the action was successful or not.
query.action_result.not[] string Optional enum: ["success","failure"]
query.action_type.not array Optional Filters out audit logs by the action type.
query.action_type.not[] string Optional enum: ["create","delete","view","update"]
query.actor_context.not array Optional Filters out audit logs by the actor context. - api: The action was performed through the API. The specific credential type was not recorded. - api_key: The action was authenticated with a Cloudflare Global API Key. - api_token: The action was authenticated with an API token. - dash: The action was performed through the Cloudflare dashboard. - oauth: The action was authenticated with an OAuth token. - origin_ca_key: The action was authenticated with an Origin CA key.
query.actor_context.not[] string Optional enum: ["api","api_key","api_token","dash","oauth","origin_ca_key"]
query.actor_email.not array Optional Filters out audit logs by the actor's email address.
query.actor_email.not[] string Optional format: "email"
query.actor_id.not array Optional Filters out audit logs by the actor's user ID.
query.actor_id.not[] string Optional
query.actor_ip_address.not array Optional Filters out audit logs IP address where the action was initiated.
query.actor_ip_address.not[] string Optional
query.actor_token_id.not array Optional Filters out audit logs by the API token ID when the actor context is an api_token or oauth.
query.actor_token_id.not[] string Optional
query.actor_token_name.not array Optional Filters out audit logs by the API token name when the actor context is an api_token or oauth.
query.actor_token_name.not[] string Optional
query.actor_type.not array Optional Filters out audit logs by the actor type.
query.actor_type.not[] string Optional enum: ["cloudflare_admin","system","user"]
query.id.not array Optional Filters out audit logs by their IDs.
query.id.not[] string Optional
query.raw_cf_ray_id.not array Optional Filters out audit logs by the response CF Ray ID.
query.raw_cf_ray_id.not[] string Optional
query.raw_method.not array Optional Filters out audit logs by the HTTP method for the API call.
query.raw_method.not[] string Optional
query.raw_status_code.not array Optional Filters out audit logs by the response status code that was returned.
query.raw_status_code.not[] integer Optional
query.raw_uri.not array Optional Filters out audit logs by the request URI.
query.raw_uri.not[] string Optional
query.resource_id.not array Optional Filters out audit logs by the resource ID.
query.resource_id.not[] string Optional
query.resource_product.not array Optional Filters out audit logs by the Cloudflare product associated with the changed resource.
query.resource_product.not[] string Optional
query.resource_type.not array Optional Filters out audit logs based on the unique type of resource changed by the action.
query.resource_type.not[] string Optional
query.resource_scope.not array Optional Filters out audit logs by the resource scope, specifying whether the resource is associated with an organization.
query.resource_scope.not[] string Optional enum: ["organizations"]
query.since string Required Limits the returned results to logs newer than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.before string Required Limits the returned results to logs older than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.direction string Optional Sets sorting order. enum: ["desc","asc"]; default: "desc"
query.limit number Optional The number limits the objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit. default: 100; minimum: 1; maximum: 1000
query.cursor string Optional The cursor is an opaque token used to paginate through large sets of records. It indicates the position from which to continue when requesting the next set of records. A valid cursor value can be obtained from the cursor object in the result_info structure of a previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a67e14daa5f8dceeb91fe5449ba496ef"
  },
  "query": {
    "since": "2024-10-30",
    "before": "2024-10-31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get resource change history from an organization audit log entry (Version 2) — cloudflare.audit-logs-v2-get-organization-audit-log-history

Returns the chronological change history for the resource identified by the given organization-scoped audit log entry.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id string Required The unique ID that identifies the organization.
path.id string Required The ID of the audit log to fetch resource history for. format: "uuid"
query object Required additionalProperties: false
query.action_time string Required RFC3339 timestamp of the source audit log entry's action time. Used to narrow the source-entry lookup window. Provide the action.time value from the audit log identified by id. format: "date-time"
query.since string Required Limits the returned results to logs newer than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.before string Required Limits the returned results to logs older than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. format: "date"
query.direction string Optional Sets sorting order. enum: ["desc","asc"]; default: "desc"
query.limit number Optional The number limits the objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit. default: 100; minimum: 1; maximum: 1000
query.cursor string Optional The cursor is an opaque token used to paginate through large sets of records. It indicates the position from which to continue when requesting the next set of records. A valid cursor value can be obtained from the cursor object in the result_info structure of a previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a67e14daa5f8dceeb91fe5449ba496ef",
    "id": "f174be97-19b1-40d6-954d-70cd5fbd52db"
  },
  "query": {
    "action_time": "2024-10-30T15:00:00Z",
    "since": "2024-10-30",
    "before": "2024-10-31"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization members — cloudflare.members_list

List memberships for an Organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required $ref: "#/definitions/organizations-api_OrganizationID"
query object Optional additionalProperties: false
query.status array Optional Filter the list of memberships by membership status. Defaults to active, pending, and rejected; pass canceled explicitly to include canceled memberships.
query.status[] string Optional enum: ["active","pending","rejected","canceled"]
query.user.email string Optional Filter the list of memberships for a specific email.
query.user.email.contains string Optional Filter the list of memberships for a specific email that contains a substring.
query.user.email.startsWith string Optional Filter the list of memberships for a specific email that starts with a substring.
query.user.email.endsWith string Optional Filter the list of memberships for a specific email that ends with a substring.
query.page_token string Optional An opaque token returned from the last list response that when provided will retrieve the next page. Parameters used to filter the retrieved list must remain in subsequent requests with a page token.
query.page_size integer Optional The amount of items to return. Defaults to 10. minimum: 0; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create organization member — cloudflare.members_create

Create a membership that grants access to a specific Organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required $ref: "#/definitions/organizations-api_OrganizationID"
body — Required $ref: "#/definitions/organizations-api_CreateMemberRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  },
  "body": {
    "member": {
      "user": {
        "email": "example"
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete organization member — cloudflare.members_delete

Delete a membership to a particular Organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required $ref: "#/definitions/organizations-api_OrganizationID"
path.member_id — Required $ref: "#/definitions/organizations-api_MemberID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
    "member_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get organization member — cloudflare.members_retrieve

Retrieve a single membership from an Organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required $ref: "#/definitions/organizations-api_OrganizationID"
path.member_id — Required $ref: "#/definitions/organizations-api_MemberID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
    "member_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch create organization members — cloudflare.members_batchcreate

Batch create multiple memberships that grant access to a specific Organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required $ref: "#/definitions/organizations-api_OrganizationID"
body — Required $ref: "#/definitions/organizations-api_BatchCreateMembersRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get organization profile — cloudflare.organizations_getprofile

Retrieves the business profile (name, email, phone, address, and external metadata) associated with this organization's customer record. Profiles can be shared across accounts and organizations. Only available to members of the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required The ID of the organization to retrieve a profile for. $ref: "#/definitions/organizations-api_OrganizationID"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Modify organization profile. — cloudflare.organizations_modifyprofile

Partially updates the business profile (name, email, phone, address, and external metadata) associated with this organization's customer record, creating the profile if it does not exist. Changes apply to every account and organization sharing that profile. Omitted, empty, or null fields are left unchanged. Each profile field is limited to 1,000 UTF-8 bytes. Only available to members of the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required $ref: "#/definitions/organizations-api_OrganizationID"
body — Required $ref: "#/definitions/organizations-api_ModifyProfileRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List organization shares — cloudflare.organization-shares-list

Lists all organization shares.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.organization_id — Required $ref: "#/definitions/resource-sharing_organization_id"
query object Optional additionalProperties: false
query.status — Optional Filter shares by status. $ref: "#/definitions/resource-sharing_share_status"
query.order string Optional Order shares by values in the given field. enum: ["name","created"]; default: "created"
query.direction string Optional Direction to sort objects. enum: ["asc","desc"]; default: "asc"
query.page integer Optional Page number. Defaults to 1 when omitted. default: 1; minimum: 1; multipleOf: 1
query.per_page integer Optional Number of objects to return per page. Defaults to 20 when omitted. default: 20; minimum: 1; maximum: 100; multipleOf: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "organization_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check missing assets — cloudflare.pages-assets-check-missing

Check which of the provided file hashes are missing from the Pages asset store. Returns a list of missing hashes that need to be uploaded. Used as part of the Pages Direct Upload workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/pages_pages_assets_check_missing_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "hashes": [
      "a948904f2f0f479b8f936b8a0c5d9882",
      "b026324c6904b2a9cb4b88d6d61c81d1"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload asset — cloudflare.pages-assets-upload

Upload one or more files to the Pages asset store. Each file is identified by its content hash and is uploaded using the same JSON shape as the Cloudflare KV bulk write API. Used as part of the Pages Direct Upload workflow.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/pages_pages_assets_upload_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upsert asset hashes — cloudflare.pages-assets-upsert-hashes

Register the provided file hashes as recently uploaded to the Pages asset store. Used as part of the Pages Direct Upload workflow so future deployments can avoid re-uploading files that are already present.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/pages_pages_assets_upsert_hashes_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "hashes": [
      "a948904f2f0f479b8f936b8a0c5d9882",
      "b026324c6904b2a9cb4b88d6d61c81d1"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get agent readiness summary — cloudflare.radar-get-agent-readiness-summary

Returns a summary of AI agent readiness scores across scanned domains, grouped by the specified dimension. Data is sourced from weekly bulk scans. All values are raw domain counts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the agent readiness data dimension by which to group the results. enum: ["CHECK"]
query object Optional additionalProperties: false
query.date string Optional Filters results by the specified date. format: "date"
query.domainCategory array Optional Filters results by domain category.
query.domainCategory[] string Optional maxLength: 100
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "CHECK"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AI bots HTTP requests distribution by dimension — cloudflare.radar-get-ai-bots-summary

Retrieves an aggregated summary of AI bots HTTP requests grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["USER_AGENT","CRAWL_PURPOSE","INDUSTRY","VERTICAL","CONTENT_TYPE","RESPONSE_STATUS","RESPONSE_STATUS_CATEGORY"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.crawlPurpose array Optional Filters results by bot crawl purpose.
query.crawlPurpose[] string Optional maxLength: 100
query.userAgent array Optional Filters results by user agent.
query.userAgent[] string Optional maxLength: 100
query.vertical array Optional Filters results by vertical.
query.vertical[] string Optional maxLength: 2000
query.industry array Optional Filters results by industry.
query.industry[] string Optional maxLength: 2000
query.contentType array Optional Filters results by content type category. When set, results can only be further filtered by location, continent, or Autonomous System.
query.contentType[] string Optional enum: ["HTML","IMAGES","JSON","JAVASCRIPT","CSS","PLAIN_TEXT","FONTS","XML","YAML","VIDEO","AUDIO","MARKDOWN","DOCUMENTS","BINARY","SERIALIZATION","OTHER"]
query.responseStatus array Optional Filters results by HTTP response status code (e.g. 200, 403, 404). Only IANA-registered codes are accepted.
query.responseStatus[] string Optional pattern: "^\\d{3}$"
query.responseStatusCategory array Optional Filters results by HTTP response status code category.
query.responseStatusCategory[] string Optional enum: ["INFORMATIONAL","SUCCESS","REDIRECTION","CLIENT_ERROR","SERVER_ERROR"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "USER_AGENT"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AI bots HTTP requests time series — cloudflare.radar-get-ai-bots-timeseries

Retrieves AI bots HTTP request volume over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.crawlPurpose array Optional Filters results by bot crawl purpose.
query.crawlPurpose[] string Optional maxLength: 100
query.userAgent array Optional Filters results by user agent.
query.userAgent[] string Optional maxLength: 100
query.industry array Optional Filters results by industry.
query.industry[] string Optional maxLength: 2000
query.vertical array Optional Filters results by vertical.
query.vertical[] string Optional maxLength: 2000
query.contentType array Optional Filters results by content type category. When set, results can only be further filtered by location, continent, or Autonomous System.
query.contentType[] string Optional enum: ["HTML","IMAGES","JSON","JAVASCRIPT","CSS","PLAIN_TEXT","FONTS","XML","YAML","VIDEO","AUDIO","MARKDOWN","DOCUMENTS","BINARY","SERIALIZATION","OTHER"]
query.responseStatus array Optional Filters results by HTTP response status code (e.g. 200, 403, 404). Only IANA-registered codes are accepted.
query.responseStatus[] string Optional pattern: "^\\d{3}$"
query.responseStatusCategory array Optional Filters results by HTTP response status code category.
query.responseStatusCategory[] string Optional enum: ["INFORMATIONAL","SUCCESS","REDIRECTION","CLIENT_ERROR","SERVER_ERROR"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time series distribution of AI bots HTTP requests by dimension. — cloudflare.radar-get-ai-bots-timeseries-group

Retrieves the distribution of HTTP requests from AI bots, grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["USER_AGENT","CRAWL_PURPOSE","INDUSTRY","VERTICAL","CONTENT_TYPE","RESPONSE_STATUS","RESPONSE_STATUS_CATEGORY"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.crawlPurpose array Optional Filters results by bot crawl purpose.
query.crawlPurpose[] string Optional maxLength: 100
query.userAgent array Optional Filters results by user agent.
query.userAgent[] string Optional maxLength: 100
query.industry array Optional Filters results by industry.
query.industry[] string Optional maxLength: 2000
query.vertical array Optional Filters results by vertical.
query.vertical[] string Optional maxLength: 2000
query.contentType array Optional Filters results by content type category. When set, results can only be further filtered by location, continent, or Autonomous System.
query.contentType[] string Optional enum: ["HTML","IMAGES","JSON","JAVASCRIPT","CSS","PLAIN_TEXT","FONTS","XML","YAML","VIDEO","AUDIO","MARKDOWN","DOCUMENTS","BINARY","SERIALIZATION","OTHER"]
query.responseStatus array Optional Filters results by HTTP response status code (e.g. 200, 403, 404). Only IANA-registered codes are accepted.
query.responseStatus[] string Optional pattern: "^\\d{3}$"
query.responseStatusCategory array Optional Filters results by HTTP response status code category.
query.responseStatusCategory[] string Optional enum: ["INFORMATIONAL","SUCCESS","REDIRECTION","CLIENT_ERROR","SERVER_ERROR"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE","MIN0_MAX","PERCENTAGE_CHANGE"]; default: "PERCENTAGE"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "USER_AGENT"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Workers AI inference distribution by dimension — cloudflare.radar-get-ai-inference-summary

Retrieves an aggregated summary of the number of inferences run on Workers AI, grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["MODEL","TASK"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "MODEL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time series distribution of Workers AI inference by dimension. — cloudflare.radar-get-ai-inference-timeseries-group

Retrieves the distribution of the number of inferences run on Workers AI, grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["MODEL","TASK"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["PERCENTAGE","MIN0_MAX"]; default: "PERCENTAGE"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "MODEL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AI markdown for agents reduction ratio summary — cloudflare.radar-get-ai-markdown-for-agents-summary

Retrieves the overall median HTML-to-markdown reduction ratio for AI agent requests over the given date range.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AI markdown for agents reduction ratio time series — cloudflare.radar-get-ai-markdown-for-agents-timeseries

Retrieves the median HTML-to-markdown reduction ratio over time for AI agent requests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get latest annotations — cloudflare.radar-get-annotations

Retrieves the latest annotations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.dateRange string Optional Filters results by a relative date range ending at the current time. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd. pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.dataSource string Optional Filters results by data source. enum: ["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"]
query.eventType string Optional Filters results by event type. EVENT is a legacy alias for GENERAL. enum: ["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"]
query.outageType string Optional Filters results by outage type. enum: ["NATIONWIDE","REGIONAL","NETWORK","PLATFORM"]
query.outageCause string Optional Filters results by outage cause. enum: ["BLOCKING","CABLE_CUT","CYBERATTACK","DNS","FIRE","GOVERNMENT_DIRECTED","MAINTENANCE","MECHANICAL","MILITARY_ACTION","MISCONFIGURATION","NATURAL_DISASTER","NETWORK_PROBLEM","POWER_OUTAGE","SOFTWARE","TECHNICAL_PROBLEM","UNKNOWN","WEATHER"]
query.tags array Optional Filters results by annotation tag. Matches annotations carrying at least one of the given tags.
query.tags[] string Optional Dimension tag an annotation applies to. enum: ["ADM1","ADM2","API_TRAFFIC","ARC","AS","ASN","ATTACKS","AUTHOR","BANDWIDTH","BITRATE","BOT","BOT_CATEGORY","BOT_CLASS","BOT_KIND","BOT_OPERATOR","BROWSER","BROWSER_FAMILY","BYTES","CA","CACHE_HIT","CA_OWNER","CHECK_RESULT","CLIENT_TYPE","COMPROMISED","CONTENT_TYPE","CRAWL_PURPOSE","CRAWL_REFER_RATIO","DEVICE_TYPE","DKIM","DMARC","DNS","DNSSEC","DNSSEC_AWARE","DNSSEC_E2E","DOMAIN_CATEGORY","DURATION","EDNS","ENCRYPTED","ENTRY_TYPE","EXPIRATION_STATUS","HAS_IPS","HAS_MATCHING_ANSWER","HAS_WILDCARDS","HTTP_METHOD","HTTP_PROTOCOL","HTTP_VERSION","INDUSTRY","IP_VERSION","JITTER","KEY_AGREEMENT","LATENCY","LOCATION","LOCATION_LATENCY","LOG","LOG_API","LOG_OPERATOR","MALICIOUS","MANAGED_RULES","MITIGATION_PRODUCT","MODEL","NAMESERVER_LATENCY","ORIGIN","ORIGIN_AS","ORIGIN_LOCATION","ORIGIN_TARGET_LOCATION_PAIR","OS","PERCENTILE","POST_QUANTUM","PREFIX","PRODUCT","PROTOCOL","PROVIDER","PUBLIC_KEY_ALGORITHM","QUERY_TYPE","REFERER","REGION","RESPONSE_CODE","RESPONSE_STATUS","RESPONSE_STATUS_CATEGORY","RESPONSE_TTL","SIGNATURE_ALGORITHM","SPAM","SPF","SPOOF","SUCCESS_RATE","TARGET_LOCATION","TASK","THREAT_CATEGORY","TLD","TLD_DNS_MAGNITUDE","TLS_VERSION","UPDATE_TYPE","USER_AGENT","VALIDATION_LEVEL","VECTOR","VERTICAL"]
query.query string Optional Filters results by a free-text match on the annotation description, id, or linked entities (location, ASN, origin). maxLength: 100
query.asn integer Optional Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
query.location string Optional Filters results by location. Specify an alpha-2 location code. minLength: 2; maxLength: 2
query.geoId string Optional Filters results by geolocation. Refer to GeoNames. maxLength: 100
query.origin string Optional Filters results by origin. maxLength: 100
query.tld string Optional Filters results by top-level domain. minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.ca string Optional Filters results by certificate authority. maxLength: 100
query.log string Optional Filters results by certificate log. maxLength: 100
query.bot string Optional Filters results by bot. maxLength: 100
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get latest Internet outages and anomalies — cloudflare.radar-get-annotations-outages

Retrieves the latest Internet outages and anomalies.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.dateRange string Optional Filters results by a relative date range ending at the current time. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd. pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.dataSource string Optional Filters results by data source. enum: ["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"]
query.outageType string Optional Filters results by outage type. enum: ["NATIONWIDE","REGIONAL","NETWORK","PLATFORM"]
query.outageCause string Optional Filters results by outage cause. enum: ["BLOCKING","CABLE_CUT","CYBERATTACK","DNS","FIRE","GOVERNMENT_DIRECTED","MAINTENANCE","MECHANICAL","MILITARY_ACTION","MISCONFIGURATION","NATURAL_DISASTER","NETWORK_PROBLEM","POWER_OUTAGE","SOFTWARE","TECHNICAL_PROBLEM","UNKNOWN","WEATHER"]
query.tags array Optional Filters results by annotation tag. Matches annotations carrying at least one of the given tags.
query.tags[] string Optional Dimension tag an annotation applies to. enum: ["ADM1","ADM2","API_TRAFFIC","ARC","AS","ASN","ATTACKS","AUTHOR","BANDWIDTH","BITRATE","BOT","BOT_CATEGORY","BOT_CLASS","BOT_KIND","BOT_OPERATOR","BROWSER","BROWSER_FAMILY","BYTES","CA","CACHE_HIT","CA_OWNER","CHECK_RESULT","CLIENT_TYPE","COMPROMISED","CONTENT_TYPE","CRAWL_PURPOSE","CRAWL_REFER_RATIO","DEVICE_TYPE","DKIM","DMARC","DNS","DNSSEC","DNSSEC_AWARE","DNSSEC_E2E","DOMAIN_CATEGORY","DURATION","EDNS","ENCRYPTED","ENTRY_TYPE","EXPIRATION_STATUS","HAS_IPS","HAS_MATCHING_ANSWER","HAS_WILDCARDS","HTTP_METHOD","HTTP_PROTOCOL","HTTP_VERSION","INDUSTRY","IP_VERSION","JITTER","KEY_AGREEMENT","LATENCY","LOCATION","LOCATION_LATENCY","LOG","LOG_API","LOG_OPERATOR","MALICIOUS","MANAGED_RULES","MITIGATION_PRODUCT","MODEL","NAMESERVER_LATENCY","ORIGIN","ORIGIN_AS","ORIGIN_LOCATION","ORIGIN_TARGET_LOCATION_PAIR","OS","PERCENTILE","POST_QUANTUM","PREFIX","PRODUCT","PROTOCOL","PROVIDER","PUBLIC_KEY_ALGORITHM","QUERY_TYPE","REFERER","REGION","RESPONSE_CODE","RESPONSE_STATUS","RESPONSE_STATUS_CATEGORY","RESPONSE_TTL","SIGNATURE_ALGORITHM","SPAM","SPF","SPOOF","SUCCESS_RATE","TARGET_LOCATION","TASK","THREAT_CATEGORY","TLD","TLD_DNS_MAGNITUDE","TLS_VERSION","UPDATE_TYPE","USER_AGENT","VALIDATION_LEVEL","VECTOR","VERTICAL"]
query.query string Optional Filters results by a free-text match on the annotation description, id, or linked entities (location, ASN, origin). maxLength: 100
query.asn integer Optional Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
query.location string Optional Filters results by location. Specify an alpha-2 location code. minLength: 2; maxLength: 2
query.geoId string Optional Filters results by geolocation. Refer to GeoNames. maxLength: 100
query.origin string Optional Filters results by origin. maxLength: 100
query.tld string Optional Filters results by top-level domain. minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.ca string Optional Filters results by certificate authority. maxLength: 100
query.log string Optional Filters results by certificate log. maxLength: 100
query.bot string Optional Filters results by bot. maxLength: 100
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the number of outages by location — cloudflare.radar-get-annotations-outages-top

Retrieves the number of outages by location.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.dateRange string Optional Filters results by a relative date range ending at the current time. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd. pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get annotation by ID — cloudflare.radar-get-annotation-by-id

Retrieves a single annotation by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required Annotation ID. pattern: "^[1-9]\\d{0,18}$"
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "550"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AS112 summary by dimension — cloudflare.radar-get-dns-as112-summary

Retrieves the distribution of AS112 queries by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["DNSSEC","EDNS","IP_VERSION","PROTOCOL","QUERY_TYPE","RESPONSE_CODE"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "DNSSEC"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AS112 DNS queries time series — cloudflare.radar-get-dns-as112-timeseries

Retrieves the AS112 DNS queries over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AS112 time series grouped by dimension — cloudflare.radar-get-dns-as112-timeseries-group

Retrieves the distribution of AS112 queries grouped by dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["DNSSEC","EDNS","IP_VERSION","PROTOCOL","QUERY_TYPE","RESPONSE_CODE"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "DNSSEC"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by AS112 DNS queries — cloudflare.radar-get-dns-as112-top-locations

Retrieves the top locations by AS112 DNS queries.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by AS112 DNS queries with DNSSEC support — cloudflare.radar-get-dns-as112-top-locations-by-dnssec

Retrieves the top locations of DNS queries to AS112 with DNSSEC (DNS Security Extensions) support.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dnssec string Required DNSSEC (DNS Security Extensions) status. enum: ["SUPPORTED","NOT_SUPPORTED"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dnssec": "SUPPORTED"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by AS112 DNS queries with EDNS support — cloudflare.radar-get-dns-as112-top-locations-by-edns

Retrieves the top locations of DNS queries to AS112 with EDNS (Extension Mechanisms for DNS) support.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.edns string Required EDNS (Extension Mechanisms for DNS) status. enum: ["SUPPORTED","NOT_SUPPORTED"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "edns": "SUPPORTED"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by AS112 DNS queries for an IP version — cloudflare.radar-get-dns-as112-top-locations-by-ip-version

Retrieves the top locations of DNS queries to AS112 for an IP version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip_version string Required IP version. enum: ["IPv4","IPv6"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip_version": "IPv4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get layer 3 attacks summary by dimension — cloudflare.radar-get-attacks-layer3-summary

Retrieves the distribution of layer 3 attacks by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["PROTOCOL","IP_VERSION","VECTOR","DURATION","BITRATE","VERTICAL","INDUSTRY"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.protocol array Optional Filters the results by layer 3/4 protocol.
query.protocol[] string Optional enum: ["UDP","TCP","ICMP","GRE"]
query.direction string Optional Specifies whether the location filter applies to the source or target location. enum: ["ORIGIN","TARGET"]; default: "ORIGIN"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "PROTOCOL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get layer 3 attacks by bytes time series — cloudflare.radar-get-attacks-layer3-timeseries-by-bytes

Retrieves layer 3 attacks over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.protocol array Optional Filters the results by layer 3/4 protocol.
query.protocol[] string Optional enum: ["UDP","TCP","ICMP","GRE"]
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE_CHANGE","MIN0_MAX"]
query.metric string Optional Measurement units, eg. bytes. enum: ["BYTES","BYTES_OLD"]; default: "bytes"
query.direction string Optional Specifies whether the location filter applies to the source or target location. enum: ["ORIGIN","TARGET"]; default: "ORIGIN"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get layer 3 attacks time series grouped by dimension — cloudflare.radar-get-attacks-layer3-timeseries-group

Retrieves the distribution of layer 3 attacks grouped by dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["PROTOCOL","IP_VERSION","VECTOR","DURATION","BITRATE","VERTICAL","INDUSTRY"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.protocol array Optional Filters the results by layer 3/4 protocol.
query.protocol[] string Optional enum: ["UDP","TCP","ICMP","GRE"]
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["PERCENTAGE","MIN0_MAX"]; default: "PERCENTAGE"
query.direction string Optional Specifies whether the location filter applies to the source or target location. enum: ["ORIGIN","TARGET"]; default: "ORIGIN"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "PROTOCOL"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top layer 3 attack pairs (origin and target locations) — cloudflare.radar-get-attacks-layer3-top-attacks

Retrieves the top layer 3 attacks from origin to target location. Values are a percentage out of the total layer 3 attacks (with billing country). You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.protocol array Optional Filters the results by layer 3/4 protocol.
query.protocol[] string Optional enum: ["UDP","TCP","ICMP","GRE"]
query.limitDirection string Optional Specifies whether the limitPerLocation applies to the source or target location. enum: ["ORIGIN","TARGET"]; default: "ORIGIN"
query.limitPerLocation integer Optional Limits the number of attacks per origin/target (refer to limitDirection parameter) location. default: 10; exclusiveMinimum: 0
query.magnitude string Optional Orders results based on attack magnitude, defined by total mitigated bytes or total mitigated attacks. enum: ["MITIGATED_BYTES","MITIGATED_ATTACKS"]
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["PERCENTAGE","MIN_MAX"]; default: "PERCENTAGE"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top origin locations of layer 3 attacks — cloudflare.radar-get-attacks-layer3-top-origin-locations

Retrieves the origin locations of layer 3 attacks.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.protocol array Optional Filters the results by layer 3/4 protocol.
query.protocol[] string Optional enum: ["UDP","TCP","ICMP","GRE"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top target locations of layer 3 attacks — cloudflare.radar-get-attacks-layer3-top-target-locations

Retrieves the target locations of layer 3 attacks.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.protocol array Optional Filters the results by layer 3/4 protocol.
query.protocol[] string Optional enum: ["UDP","TCP","ICMP","GRE"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get layer 7 attacks summary by dimension — cloudflare.radar-get-attacks-layer7-summary

Retrieves the distribution of layer 7 attacks by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["HTTP_METHOD","HTTP_VERSION","IP_VERSION","MANAGED_RULES","MITIGATION_PRODUCT","VERTICAL","INDUSTRY"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.httpMethod array Optional Filters results by HTTP method.
query.httpMethod[] string Optional enum: ["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"]
query.mitigationProduct array Optional Filters the results by layer 7 mitigation product.
query.mitigationProduct[] string Optional enum: ["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "HTTP_METHOD"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get layer 7 attacks time series — cloudflare.radar-get-attacks-layer7-timeseries

Retrieves layer 7 attacks over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE_CHANGE","MIN0_MAX"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.httpMethod array Optional Filters results by HTTP method.
query.httpMethod[] string Optional enum: ["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"]
query.mitigationProduct array Optional Filters the results by layer 7 mitigation product.
query.mitigationProduct[] string Optional enum: ["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get layer 7 attacks time series grouped by dimension — cloudflare.radar-get-attacks-layer7-timeseries-group

Retrieves the distribution of layer 7 attacks grouped by dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["HTTP_METHOD","HTTP_VERSION","IP_VERSION","MANAGED_RULES","MITIGATION_PRODUCT","VERTICAL","INDUSTRY"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.httpMethod array Optional Filters results by HTTP method.
query.httpMethod[] string Optional enum: ["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"]
query.mitigationProduct array Optional Filters the results by layer 7 mitigation product.
query.mitigationProduct[] string Optional enum: ["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"]
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["PERCENTAGE","MIN0_MAX"]; default: "PERCENTAGE"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "HTTP_METHOD"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top origin ASes of layer 7 attacks — cloudflare.radar-get-attacks-layer7-top-origin-as

Retrieves the top origin autonomous systems of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin autonomous systems determined by the client IP address.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.httpMethod array Optional Filters results by HTTP method.
query.httpMethod[] string Optional enum: ["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"]
query.mitigationProduct array Optional Filters the results by layer 7 mitigation product.
query.mitigationProduct[] string Optional enum: ["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top layer 7 attack pairs (origin and target locations) — cloudflare.radar-get-attacks-layer7-top-attacks

Retrieves the top attacks from origin to target location. Values are percentages of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.mitigationProduct array Optional Filters the results by layer 7 mitigation product.
query.mitigationProduct[] string Optional enum: ["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"]
query.limitDirection string Optional Specifies whether the limitPerLocation applies to the source or target location. enum: ["ORIGIN","TARGET"]; default: "ORIGIN"
query.limitPerLocation integer Optional Limits the number of attacks per origin/target (refer to limitDirection parameter) location. default: 10; exclusiveMinimum: 0
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["PERCENTAGE","MIN_MAX"]; default: "PERCENTAGE"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top origin locations of layer 7 attacks — cloudflare.radar-get-attacks-layer7-top-origin-location

Retrieves the top origin locations of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin location determined by the client IP address.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.httpMethod array Optional Filters results by HTTP method.
query.httpMethod[] string Optional enum: ["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"]
query.mitigationProduct array Optional Filters the results by layer 7 mitigation product.
query.mitigationProduct[] string Optional enum: ["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top target locations of layer 7 attacks — cloudflare.radar-get-attacks-layer7-top-target-location

Retrieves the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.mitigationProduct array Optional Filters the results by layer 7 mitigation product.
query.mitigationProduct[] string Optional enum: ["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get BGP hijack events — cloudflare.radar-get-bgp-hijacks-events

Retrieves the BGP hijack events.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page integer Optional Current page number, starting from 1. default: 1; exclusiveMinimum: 0
query.per_page integer Optional Number of entries per page. default: 50; exclusiveMinimum: 0
query.eventId integer Optional The unique identifier of a event.
query.hijackerAsn integer Optional The potential hijacker AS of a BGP hijack event.
query.victimAsn integer Optional The potential victim AS of a BGP hijack event.
query.involvedAsn integer Optional The potential hijacker or victim AS of a BGP hijack event.
query.involvedCountry string Optional The country code of the potential hijacker or victim AS of a BGP hijack event. minLength: 2; maxLength: 2
query.prefix — Optional
query.prefix string Optional anyOf[1]
query.prefix string Optional anyOf[2]
query.minConfidence integer Optional Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high).
query.maxConfidence integer Optional Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high).
query.dateRange string Optional Filters results by a relative date range ending at the current time. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd. pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.sortBy string Optional Sorts results by the specified field. enum: ["ID","TIME","CONFIDENCE"]
query.sortOrder string Optional Sort order. enum: ["ASC","DESC"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get announced IP address space time series — cloudflare.radar-get-bgp-ips-timeseries

Retrieves time series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 location codes.
query.location[] string Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.includeDelay boolean Optional Includes data delay meta information.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by announced IP space — cloudflare.radar-get-bgp-ips-top-ases

Returns the top-N autonomous systems by announced IP space at the nearest 8-hour RIB boundary at or before the requested date. The snapped boundary is returned as anchor_ts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.date string Optional Filters results by the specified datetime (ISO 8601). format: "date-time"
query.limit integer Optional Limits the number of objects returned in the response. default: 5; minimum: 1; maximum: 50
query.metric string Optional Ranking metric: IPv4 /24 count or IPv6 /48 count. enum: ["v4_24s","v6_48s"]
query.country string Optional Optional ISO 3166-1 alpha-2 country filter. Omit for global top-N. minLength: 2; maxLength: 2
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get BGP route leak events — cloudflare.radar-get-bgp-route-leak-events

Retrieves the BGP route leak events.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page integer Optional Current page number, starting from 1. default: 1; exclusiveMinimum: 0
query.per_page integer Optional Number of entries per page. default: 50; exclusiveMinimum: 0
query.eventId integer Optional The unique identifier of a event.
query.leakAsn integer Optional The leaking AS of a route leak event.
query.involvedAsn integer Optional ASN that is causing or affected by a route leak event.
query.involvedCountry string Optional Country code of a involved ASN in a route leak event. minLength: 2; maxLength: 2
query.dateRange string Optional Filters results by a relative date range ending at the current time. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd. pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.sortBy string Optional Sorts results by the specified field. enum: ["ID","LEAKS","PEERS","PREFIXES","ORIGINS","TIME"]
query.sortOrder string Optional Sort order. enum: ["ASC","DESC"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List ASes from global routing tables — cloudflare.radar-get-bgp-routes-asns

Retrieves all ASes in the current global routing tables with routing statistics.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.location string Optional Filters results by location. Specify an alpha-2 location code. minLength: 2; maxLength: 2
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.sortBy string Optional Sorts results by the specified field. enum: ["cone","pfxs","ipv4","ipv6","rpki_valid","rpki_invalid","rpki_unknown"]
query.sortOrder string Optional Sort order. enum: ["ASC","DESC"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Multi-Origin AS (MOAS) prefixes — cloudflare.radar-get-bgp-pfx2as-moas

Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.origin integer Optional Lookup MOASes originated by the given ASN.
query.prefix — Optional
query.prefix string Optional anyOf[1]
query.prefix string Optional anyOf[2]
query.invalid_only boolean Optional Lookup only RPKI invalid MOASes.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get tier-1 path segments for an AS — cloudflare.radar-get-bgp-routes-paths

Retrieves the paths an AS uses to reach the tier-1 clique, derived from RouteViews RIB snapshots. Each entry is an ordered AS-path segment (from the queried AS toward a tier-1) with the number of observed paths and peers, and the collectors that observed it. By default segments are merged across all active collectors; pass "collector" to scope to one. The response also includes an "asnInfo" map (keyed by ASN) with the name and country for every ASN in the returned segments plus the queried ASN (best-effort; null when unavailable).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asn integer Required Single Autonomous System Number (ASN) as integer.
query object Optional additionalProperties: false
query.ipVersion string Optional Address family of the observed paths. Defaults to IPv4. enum: ["IPv4","IPv6"]; default: "IPv4"
query.collector string Optional Scope to a single RouteViews collector (e.g. "route-views3"). Omit to merge across all active collectors (identical path segments are deduplicated, observation counts summed, and every contributing collector listed). maxLength: 100
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asn": 174
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get prefix-to-ASN mapping — cloudflare.radar-get-bgp-pfx2as

Retrieves the prefix-to-ASN mapping from global routing tables.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.prefix — Optional
query.prefix string Optional anyOf[1]
query.prefix string Optional anyOf[2]
query.origin integer Optional Lookup prefixes originated by the given ASN.
query.rpkiStatus string Optional Return only results with matching rpki status: valid, invalid or unknown. enum: ["VALID","INVALID","UNKNOWN"]
query.longestPrefixMatch boolean Optional Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get real-time BGP routes for a prefix — cloudflare.radar-get-bgp-routes-realtime

Retrieves real-time BGP routes for a prefix, using public real-time data collectors (RouteViews and RIPE RIS).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.prefix — Optional
query.prefix string Optional anyOf[1]
query.prefix string Optional anyOf[2]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get BGP routing table stats — cloudflare.radar-get-bgp-routes-stats

Retrieves the BGP routing table stats.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.asn integer Optional Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
query.location string Optional Filters results by location. Specify an alpha-2 location code. minLength: 2; maxLength: 2
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get upstream composition time series for an AS — cloudflare.radar-get-bgp-routes-upstreams-timeseries

Retrieves the share of an AS’s observed paths carried by each direct upstream over time, derived from RouteViews RIB snapshots across all collectors (the combined product). Each upstream ASN is returned as its own series of shares (0–1); the least-significant upstreams beyond the requested limit are grouped into an "OTHER" series. Series share a common set of timestamps.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asn integer Required Single Autonomous System Number (ASN) as integer.
query object Optional additionalProperties: false
query.ipVersion string Optional Address family of the observed paths. Defaults to IPv4. enum: ["IPv4","IPv6"]; default: "IPv4"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.limit integer Optional Number of upstream ASNs to return as separate series, ranked by the first bucket. Remaining upstreams are grouped into an "OTHER" series. Defaults to 5.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asn": 174
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get ASPA changes over time — cloudflare.radar-get-bgp-rpki-aspa-changes

Retrieves ASPA (Autonomous System Provider Authorization) changes over time. Returns daily aggregated changes including additions, removals, and modifications of ASPA objects.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.asn integer Optional Filter changes involving this ASN (as customer or provider).
query.includeAsnInfo boolean Optional Include ASN metadata (name, country) in response.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get ASPA objects snapshot — cloudflare.radar-get-bgp-rpki-aspa-snapshot

Retrieves current or historical ASPA (Autonomous System Provider Authorization) objects. ASPA objects define which ASNs are authorized upstream providers for a customer ASN.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.customerAsn integer Optional Filter by customer ASN (the ASN publishing the ASPA object).
query.providerAsn integer Optional Filter by provider ASN (an authorized upstream provider in ASPA objects).
query.date string Optional Filters results by the specified datetime (ISO 8601). format: "date-time"
query.includeAsnInfo boolean Optional Include ASN metadata (name, country) in response.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get ASPA count time series — cloudflare.radar-get-bgp-rpki-aspa-timeseries

Retrieves ASPA (Autonomous System Provider Authorization) object count over time. Supports filtering by RIR or location (country code) to generate multiple named series. If no RIR or location filter is specified, returns total count.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.rir array Optional Filter by Regional Internet Registry (RIR). Multiple RIRs generate multiple series.
query.rir[] string Optional enum: ["RIPE_NCC","ARIN","APNIC","LACNIC","AFRINIC"]
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 location codes.
query.location[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get RPKI ROA deployment time series — cloudflare.radar-get-bgp-rpki-roas-timeseries

Retrieves RPKI ROA (Route Origin Authorization) validation ratios over time. Returns the selected metric as a time series. Supports filtering by ASN or location (country code) — multiple values of the same filter type produce one series per value. If no ASN or location is specified, returns the global aggregate.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.metric string Optional Which RPKI ROA validation metric to return. validPfxsRatio = ratio of RPKI-valid prefixes (IPv4+IPv6 combined). validPfxsV4Ratio / validPfxsV6Ratio = same, split by IP version. validIpsRatio = ratio of RPKI-valid address space (IPv4 /24s + IPv6 /48s). validIpsV4Ratio / validIpsV6Ratio = same, split by IP version. enum: ["validPfxsRatio","validPfxsV4Ratio","validPfxsV6Ratio","validIpsRatio","validIpsV4Ratio","validIpsV6Ratio"]; default: "validPfxsRatio"
query.asn array Optional Filters results by Autonomous System Number. Specify one or more ASNs. Multiple values generate one series per ASN.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 location codes.
query.location[] string Optional
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get BGP time series — cloudflare.radar-get-bgp-timeseries

Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.prefix array Optional Filters results by BGP network prefix.
query.prefix[] — Optional
query.prefix[] string Optional anyOf[1]
query.prefix[] string Optional anyOf[2]
query.updateType array Optional Filters results by BGP update type.
query.updateType[] string Optional enum: ["ANNOUNCEMENT","WITHDRAWAL"]
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by BGP updates — cloudflare.radar-get-bgp-top-ases

Retrieves the top autonomous systems by BGP updates (announcements only).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.prefix array Optional Filters results by BGP network prefix.
query.prefix[] — Optional
query.prefix[] string Optional anyOf[1]
query.prefix[] string Optional anyOf[2]
query.updateType array Optional Filters results by BGP update type.
query.updateType[] string Optional enum: ["ANNOUNCEMENT","WITHDRAWAL"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by prefix count — cloudflare.radar-get-bgp-top-asns-by-prefixes

Retrieves the full list of autonomous systems on the global routing table ordered by announced prefixes count. The data comes from public BGP MRT data archives and updates every 2 hours.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.country string Optional Alpha-2 country code.
query.limit integer Optional Maximum number of ASes to return.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top prefixes by BGP updates — cloudflare.radar-get-bgp-top-prefixes

Retrieves the top network prefixes by BGP updates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.updateType array Optional Filters results by BGP update type.
query.updateType[] string Optional enum: ["ANNOUNCEMENT","WITHDRAWAL"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List bots — cloudflare.radar-get-bots

Retrieves a list of bots.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.botCategory string Optional Filters results by bot category. enum: ["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"]
query.botOperator string Optional Filters results by bot operator. maxLength: 100
query.kind string Optional Filters results by bot kind. Deprecated: the Verified Bot / Signed Agent distinction is being removed. enum: ["AGENT","BOT"]
query.botVerificationStatus string Optional Filters results by bot verification status. enum: ["VERIFIED"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get crawler HTTP request distribution by dimension — cloudflare.radar-get-crawlers-summary

Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["CLIENT_TYPE","USER_AGENT","REFERER","CRAWL_REFER_RATIO","VERTICAL","INDUSTRY","RESPONSE_STATUS","RESPONSE_STATUS_CATEGORY"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.botOperator array Optional Filters results by bot operator.
query.botOperator[] string Optional maxLength: 100
query.vertical array Optional Filters results by vertical.
query.vertical[] string Optional maxLength: 2000
query.industry array Optional Filters results by industry.
query.industry[] string Optional maxLength: 2000
query.clientType array Optional Filters results by agent type.
query.clientType[] string Optional The type of the client. enum: ["HUMAN","NON_AI_BOT","AI_BOT","MIXED_PURPOSE"]
query.responseStatus array Optional Filters results by HTTP response status code (e.g. 200, 403, 404). Only IANA-registered codes are accepted.
query.responseStatus[] string Optional pattern: "^\\d{3}$"
query.responseStatusCategory array Optional Filters results by HTTP response status code category.
query.responseStatusCategory[] string Optional enum: ["INFORMATIONAL","SUCCESS","REDIRECTION","CLIENT_ERROR","SERVER_ERROR"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "CLIENT_TYPE"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time series of crawler HTTP request distribution by dimension — cloudflare.radar-get-crawlers-timeseries-group

Retrieves the distribution of HTTP requests from crawlers, grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["CLIENT_TYPE","USER_AGENT","REFERER","CRAWL_REFER_RATIO","VERTICAL","INDUSTRY","RESPONSE_STATUS","RESPONSE_STATUS_CATEGORY"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE","MIN0_MAX","PERCENTAGE_CHANGE"]; default: "PERCENTAGE"
query.botOperator array Optional Filters results by bot operator.
query.botOperator[] string Optional maxLength: 100
query.vertical array Optional Filters results by vertical.
query.vertical[] string Optional maxLength: 2000
query.industry array Optional Filters results by industry.
query.industry[] string Optional maxLength: 2000
query.clientType array Optional Filters results by agent type.
query.clientType[] string Optional The type of the client. enum: ["HUMAN","NON_AI_BOT","AI_BOT","MIXED_PURPOSE"]
query.responseStatus array Optional Filters results by HTTP response status code (e.g. 200, 403, 404). Only IANA-registered codes are accepted.
query.responseStatus[] string Optional pattern: "^\\d{3}$"
query.responseStatusCategory array Optional Filters results by HTTP response status code category.
query.responseStatusCategory[] string Optional enum: ["INFORMATIONAL","SUCCESS","REDIRECTION","CLIENT_ERROR","SERVER_ERROR"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "CLIENT_TYPE"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get bots HTTP requests distribution by dimension — cloudflare.radar-get-bots-summary

Retrieves an aggregated summary of bots HTTP requests grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["BOT","BOT_KIND","BOT_OPERATOR","BOT_CATEGORY"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.bot array Optional Filters results by bot name.
query.bot[] string Optional maxLength: 100
query.botOperator array Optional Filters results by bot operator.
query.botOperator[] string Optional maxLength: 100
query.botCategory array Optional Filters results by bot category.
query.botCategory[] string Optional The category of the bot. enum: ["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"]
query.botKind array Optional Filters results by bot kind. Deprecated: the Verified Bot / Signed Agent distinction is being removed.
query.botKind[] string Optional enum: ["AGENT","BOT"]
query.botVerificationStatus array Optional Filters results by bot verification status (Verified vs. Unverified).
query.botVerificationStatus[] string Optional The category of the bot. enum: ["VERIFIED"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "BOT"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get bots HTTP requests time series — cloudflare.radar-get-bots-timeseries

Retrieves bots HTTP request volume over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.bot array Optional Filters results by bot name.
query.bot[] string Optional maxLength: 100
query.botOperator array Optional Filters results by bot operator.
query.botOperator[] string Optional maxLength: 100
query.botCategory array Optional Filters results by bot category.
query.botCategory[] string Optional The category of the bot. enum: ["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"]
query.botKind array Optional Filters results by bot kind. Deprecated: the Verified Bot / Signed Agent distinction is being removed.
query.botKind[] string Optional enum: ["AGENT","BOT"]
query.botVerificationStatus array Optional Filters results by bot verification status (Verified vs. Unverified).
query.botVerificationStatus[] string Optional The category of the bot. enum: ["VERIFIED"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time series distribution of bots HTTP requests by dimension. — cloudflare.radar-get-bots-timeseries-group

Retrieves the distribution of HTTP requests from bots, grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["BOT","BOT_KIND","BOT_OPERATOR","BOT_CATEGORY"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.bot array Optional Filters results by bot name.
query.bot[] string Optional maxLength: 100
query.botOperator array Optional Filters results by bot operator.
query.botOperator[] string Optional maxLength: 100
query.botCategory array Optional Filters results by bot category.
query.botCategory[] string Optional The category of the bot. enum: ["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"]
query.botKind array Optional Filters results by bot kind. Deprecated: the Verified Bot / Signed Agent distinction is being removed.
query.botKind[] string Optional enum: ["AGENT","BOT"]
query.botVerificationStatus array Optional Filters results by bot verification status (Verified vs. Unverified).
query.botVerificationStatus[] string Optional The category of the bot. enum: ["VERIFIED"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "BOT"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get bot details — cloudflare.radar-get-bot-details

Retrieves the requested bot information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bot_slug string Required Bot slug. maxLength: 100
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bot_slug": "gptbot"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List certificate authorities — cloudflare.radar-get-certificate-authorities

Retrieves a list of certificate authorities.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get certificate authority details — cloudflare.radar-get-certificate-authority-details

Retrieves the requested CA information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ca_slug string Required Certificate authority SHA256 fingerprint. pattern: "^[A-F0-9]{64}$"
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ca_slug": "24EDD4E503A8D3FDB5FFB4AF66C887359901CBE687A5A0760D10A08EED99A7C3"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List certificate logs — cloudflare.radar-get-certificate-logs

Retrieves a list of certificate logs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get certificate log details — cloudflare.radar-get-certificate-log-details

Retrieves the requested certificate log information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.log_slug string Required Certificate log slug. maxLength: 100
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "log_slug": "argon2024"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get certificate distribution by dimension — cloudflare.radar-get-ct-summary

Retrieves an aggregated summary of certificates grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the certificate attribute by which to group the results. enum: ["CA","CA_OWNER","DURATION","ENTRY_TYPE","EXPIRATION_STATUS","HAS_IPS","HAS_WILDCARDS","LOG","LOG_API","LOG_OPERATOR","PUBLIC_KEY_ALGORITHM","SIGNATURE_ALGORITHM","TLD","VALIDATION_LEVEL"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.ca array Optional Filters results by certificate authority.
query.ca[] string Optional
query.caOwner array Optional Filters results by certificate authority owner.
query.caOwner[] string Optional
query.duration array Optional Filters results by certificate duration.
query.duration[] string Optional enum: ["LTE_3D","GT_3D_LTE_7D","GT_7D_LTE_10D","GT_10D_LTE_47D","GT_47D_LTE_100D","GT_100D_LTE_200D","GT_200D"]
query.entryType array Optional Filters results by entry type (certificate vs. pre-certificate). Incompatible with the tld filter/dimension.
query.entryType[] string Optional enum: ["PRECERTIFICATE","CERTIFICATE"]
query.expirationStatus array Optional Filters results by expiration status (expired vs. valid).
query.expirationStatus[] string Optional enum: ["EXPIRED","VALID"]
query.hasIps array Optional Filters results based on whether the certificates are bound to specific IP addresses.
query.hasIps[] boolean Optional
query.hasWildcards array Optional Filters results based on whether the certificates contain wildcard domains.
query.hasWildcards[] boolean Optional
query.log array Optional Filters results by certificate log. Incompatible with the tld filter/dimension.
query.log[] string Optional maxLength: 100
query.logApi array Optional Filters results by certificate log API (RFC6962 vs. static). Incompatible with the tld filter/dimension.
query.logApi[] string Optional enum: ["RFC6962","STATIC"]
query.logOperator array Optional Filters results by certificate log operator. Incompatible with the tld filter/dimension.
query.logOperator[] string Optional maxLength: 100
query.publicKeyAlgorithm array Optional Filters results by public key algorithm.
query.publicKeyAlgorithm[] string Optional enum: ["DSA","ECDSA","RSA"]
query.signatureAlgorithm array Optional Filters results by signature algorithm.
query.signatureAlgorithm[] string Optional enum: ["DSA_SHA_1","DSA_SHA_256","ECDSA_SHA_1","ECDSA_SHA_256","ECDSA_SHA_384","ECDSA_SHA_512","PSS_SHA_256","PSS_SHA_384","PSS_SHA_512","RSA_MD2","RSA_MD5","RSA_SHA_1","RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"]
query.tld array Optional Filters results by top-level domain. Incompatible with the log, logApi, logOperator, and entryType filters/dimensions.
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.validationLevel array Optional Filters results by validation level.
query.validationLevel[] string Optional enum: ["DOMAIN","ORGANIZATION","EXTENDED"]
query.uniqueEntries array Optional Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.
query.uniqueEntries[] string Optional enum: ["true","false"]
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["RAW_VALUES","PERCENTAGE"]; default: "RAW_VALUES"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "CA"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get certificates time series — cloudflare.radar-get-ct-timeseries

Retrieves certificate volume over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.ca array Optional Filters results by certificate authority.
query.ca[] string Optional
query.caOwner array Optional Filters results by certificate authority owner.
query.caOwner[] string Optional
query.duration array Optional Filters results by certificate duration.
query.duration[] string Optional enum: ["LTE_3D","GT_3D_LTE_7D","GT_7D_LTE_10D","GT_10D_LTE_47D","GT_47D_LTE_100D","GT_100D_LTE_200D","GT_200D"]
query.entryType array Optional Filters results by entry type (certificate vs. pre-certificate). Incompatible with the tld filter/dimension.
query.entryType[] string Optional enum: ["PRECERTIFICATE","CERTIFICATE"]
query.expirationStatus array Optional Filters results by expiration status (expired vs. valid).
query.expirationStatus[] string Optional enum: ["EXPIRED","VALID"]
query.hasIps array Optional Filters results based on whether the certificates are bound to specific IP addresses.
query.hasIps[] boolean Optional
query.hasWildcards array Optional Filters results based on whether the certificates contain wildcard domains.
query.hasWildcards[] boolean Optional
query.log array Optional Filters results by certificate log. Incompatible with the tld filter/dimension.
query.log[] string Optional maxLength: 100
query.logApi array Optional Filters results by certificate log API (RFC6962 vs. static). Incompatible with the tld filter/dimension.
query.logApi[] string Optional enum: ["RFC6962","STATIC"]
query.logOperator array Optional Filters results by certificate log operator. Incompatible with the tld filter/dimension.
query.logOperator[] string Optional maxLength: 100
query.publicKeyAlgorithm array Optional Filters results by public key algorithm.
query.publicKeyAlgorithm[] string Optional enum: ["DSA","ECDSA","RSA"]
query.signatureAlgorithm array Optional Filters results by signature algorithm.
query.signatureAlgorithm[] string Optional enum: ["DSA_SHA_1","DSA_SHA_256","ECDSA_SHA_1","ECDSA_SHA_256","ECDSA_SHA_384","ECDSA_SHA_512","PSS_SHA_256","PSS_SHA_384","PSS_SHA_512","RSA_MD2","RSA_MD5","RSA_SHA_1","RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"]
query.tld array Optional Filters results by top-level domain. Incompatible with the log, logApi, logOperator, and entryType filters/dimensions.
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.validationLevel array Optional Filters results by validation level.
query.validationLevel[] string Optional enum: ["DOMAIN","ORGANIZATION","EXTENDED"]
query.uniqueEntries array Optional Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.
query.uniqueEntries[] string Optional enum: ["true","false"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time series of certificate distribution by dimension — cloudflare.radar-get-ct-timeseries-group

Retrieves the distribution of certificates grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the certificate attribute by which to group the results. enum: ["CA","CA_OWNER","DURATION","ENTRY_TYPE","EXPIRATION_STATUS","HAS_IPS","HAS_WILDCARDS","LOG","LOG_API","LOG_OPERATOR","PUBLIC_KEY_ALGORITHM","SIGNATURE_ALGORITHM","TLD","VALIDATION_LEVEL"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.ca array Optional Filters results by certificate authority.
query.ca[] string Optional
query.caOwner array Optional Filters results by certificate authority owner.
query.caOwner[] string Optional
query.duration array Optional Filters results by certificate duration.
query.duration[] string Optional enum: ["LTE_3D","GT_3D_LTE_7D","GT_7D_LTE_10D","GT_10D_LTE_47D","GT_47D_LTE_100D","GT_100D_LTE_200D","GT_200D"]
query.entryType array Optional Filters results by entry type (certificate vs. pre-certificate). Incompatible with the tld filter/dimension.
query.entryType[] string Optional enum: ["PRECERTIFICATE","CERTIFICATE"]
query.expirationStatus array Optional Filters results by expiration status (expired vs. valid).
query.expirationStatus[] string Optional enum: ["EXPIRED","VALID"]
query.hasIps array Optional Filters results based on whether the certificates are bound to specific IP addresses.
query.hasIps[] boolean Optional
query.hasWildcards array Optional Filters results based on whether the certificates contain wildcard domains.
query.hasWildcards[] boolean Optional
query.log array Optional Filters results by certificate log. Incompatible with the tld filter/dimension.
query.log[] string Optional maxLength: 100
query.logApi array Optional Filters results by certificate log API (RFC6962 vs. static). Incompatible with the tld filter/dimension.
query.logApi[] string Optional enum: ["RFC6962","STATIC"]
query.logOperator array Optional Filters results by certificate log operator. Incompatible with the tld filter/dimension.
query.logOperator[] string Optional maxLength: 100
query.publicKeyAlgorithm array Optional Filters results by public key algorithm.
query.publicKeyAlgorithm[] string Optional enum: ["DSA","ECDSA","RSA"]
query.signatureAlgorithm array Optional Filters results by signature algorithm.
query.signatureAlgorithm[] string Optional enum: ["DSA_SHA_1","DSA_SHA_256","ECDSA_SHA_1","ECDSA_SHA_256","ECDSA_SHA_384","ECDSA_SHA_512","PSS_SHA_256","PSS_SHA_384","PSS_SHA_512","RSA_MD2","RSA_MD5","RSA_SHA_1","RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"]
query.validationLevel array Optional Filters results by validation level.
query.validationLevel[] string Optional enum: ["DOMAIN","ORGANIZATION","EXTENDED"]
query.tld array Optional Filters results by top-level domain. Incompatible with the log, logApi, logOperator, and entryType filters/dimensions.
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["RAW_VALUES","PERCENTAGE"]; default: "RAW_VALUES"
query.uniqueEntries array Optional Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.
query.uniqueEntries[] string Optional enum: ["true","false"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "CA"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List datasets — cloudflare.radar-get-reports-datasets

Retrieves a list of datasets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.datasetType string Optional Filters results by dataset type. enum: ["RANKING_BUCKET","REPORT"]; default: "RANKING_BUCKET"
query.date string Optional Filters results by the specified date. format: "date"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get dataset download URL — cloudflare.radar-post-reports-dataset-download-url

Retrieves an URL to download a single dataset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]
body object Optional
body.datasetId integer Required

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get dataset CSV stream — cloudflare.radar-get-reports-dataset-download

Retrieves the CSV content of a given dataset by alias or ID. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.alias string Required Dataset alias or ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "alias": "ranking_top_1000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DNS summary by dimension — cloudflare.radar-get-dns-summary

Retrieves the distribution of DNS queries by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. Grouping by TLD_DNS_MAGNITUDE does not support sub-daily aggregation intervals; 15m and 1h are raised to 1d. enum: ["AS","CACHE_HIT","DNSSEC","DNSSEC_AWARE","DNSSEC_E2E","IP_VERSION","LOCATION","MATCHING_ANSWER","PROTOCOL","QUERY_TYPE","RESPONSE_CODE","RESPONSE_TTL","TLD","TLD_DNS_MAGNITUDE"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.cacheHit array Optional Filters results based on cache status.
query.cacheHit[] boolean Optional
query.nodata array Optional Specifies whether the response includes empty DNS responses (NODATA). default: ["true"]
query.nodata[] boolean Optional
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.responseTtl array Optional Filters results by DNS response TTL.
query.responseTtl[] string Optional enum: ["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"]
query.dnssec array Optional Filters results based on DNSSEC (DNS Security Extensions) support.
query.dnssec[] string Optional enum: ["INVALID","INSECURE","SECURE","OTHER"]
query.dnssecAware array Optional Filters results based on DNSSEC (DNS Security Extensions) client awareness.
query.dnssecAware[] string Optional enum: ["SUPPORTED","NOT_SUPPORTED"]
query.dnssecE2e array Optional Filters results based on DNSSEC-validated answers by end-to-end security status.
query.dnssecE2e[] boolean Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.matchingAnswer array Optional Filters results based on whether the queries have a matching answer.
query.matchingAnswer[] boolean Optional
query.tld array Optional Filters results by top-level domain. Incompatible with the ipVersion, protocol, dnssecE2e, dnssecAware, responseTtl, and cacheHit filters/dimensions; this restriction does not apply to country-code TLDs (2-letter, e.g. uk).
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "AS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DNS queries time series — cloudflare.radar-get-dns-timeseries

Retrieves normalized query volume to the 1.1.1.1 DNS resolver over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.cacheHit array Optional Filters results based on cache status.
query.cacheHit[] boolean Optional
query.nodata array Optional Specifies whether the response includes empty DNS responses (NODATA). default: ["true"]
query.nodata[] boolean Optional
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.responseTtl array Optional Filters results by DNS response TTL.
query.responseTtl[] string Optional enum: ["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"]
query.dnssec array Optional Filters results based on DNSSEC (DNS Security Extensions) support.
query.dnssec[] string Optional enum: ["INVALID","INSECURE","SECURE","OTHER"]
query.dnssecAware array Optional Filters results based on DNSSEC (DNS Security Extensions) client awareness.
query.dnssecAware[] string Optional enum: ["SUPPORTED","NOT_SUPPORTED"]
query.dnssecE2e array Optional Filters results based on DNSSEC-validated answers by end-to-end security status.
query.dnssecE2e[] boolean Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.matchingAnswer array Optional Filters results based on whether the queries have a matching answer.
query.matchingAnswer[] boolean Optional
query.tld array Optional Filters results by top-level domain. Incompatible with the ipVersion, protocol, dnssecE2e, dnssecAware, responseTtl, and cacheHit filters/dimensions; this restriction does not apply to country-code TLDs (2-letter, e.g. uk).
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DNS time series grouped by dimension — cloudflare.radar-get-dns-timeseries-group

Retrieves the distribution of DNS queries grouped by dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. Grouping by TLD_DNS_MAGNITUDE does not support sub-daily aggregation intervals; 15m and 1h are raised to 1d. enum: ["AS","CACHE_HIT","DNSSEC","DNSSEC_AWARE","DNSSEC_E2E","IP_VERSION","LOCATION","MATCHING_ANSWER","PROTOCOL","QUERY_TYPE","RESPONSE_CODE","RESPONSE_TTL","TLD","TLD_DNS_MAGNITUDE"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.cacheHit array Optional Filters results based on cache status.
query.cacheHit[] boolean Optional
query.nodata array Optional Specifies whether the response includes empty DNS responses (NODATA). default: ["true"]
query.nodata[] boolean Optional
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.responseTtl array Optional Filters results by DNS response TTL.
query.responseTtl[] string Optional enum: ["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"]
query.dnssec array Optional Filters results based on DNSSEC (DNS Security Extensions) support.
query.dnssec[] string Optional enum: ["INVALID","INSECURE","SECURE","OTHER"]
query.dnssecAware array Optional Filters results based on DNSSEC (DNS Security Extensions) client awareness.
query.dnssecAware[] string Optional enum: ["SUPPORTED","NOT_SUPPORTED"]
query.dnssecE2e array Optional Filters results based on DNSSEC-validated answers by end-to-end security status.
query.dnssecE2e[] boolean Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.matchingAnswer array Optional Filters results based on whether the queries have a matching answer.
query.matchingAnswer[] boolean Optional
query.tld array Optional Filters results by top-level domain. Incompatible with the ipVersion, protocol, dnssecE2e, dnssecAware, responseTtl, and cacheHit filters/dimensions; this restriction does not apply to country-code TLDs (2-letter, e.g. uk).
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. RANK is only meaningful with the TLD_DNS_MAGNITUDE dimension, where it ranks TLDs by DNS query magnitude at each timestamp; for other dimensions it has no effect. enum: ["PERCENTAGE","MIN0_MAX","RANK"]; default: "PERCENTAGE"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "AS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by DNS queries — cloudflare.radar-get-dns-top-ases

Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS resolver.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.domain array Optional Filters results by domain name. When set, no other DNS filter may be used — only date filtering (dateRange, or dateStart/dateEnd) is allowed — and the date range cannot exceed 31 days.
query.domain[] string Optional minLength: 1; maxLength: 253; pattern: "^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$"
query.cacheHit array Optional Filters results based on cache status.
query.cacheHit[] boolean Optional
query.nodata array Optional Specifies whether the response includes empty DNS responses (NODATA). default: ["true"]
query.nodata[] boolean Optional
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.responseTtl array Optional Filters results by DNS response TTL.
query.responseTtl[] string Optional enum: ["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"]
query.dnssec array Optional Filters results based on DNSSEC (DNS Security Extensions) support.
query.dnssec[] string Optional enum: ["INVALID","INSECURE","SECURE","OTHER"]
query.dnssecAware array Optional Filters results based on DNSSEC (DNS Security Extensions) client awareness.
query.dnssecAware[] string Optional enum: ["SUPPORTED","NOT_SUPPORTED"]
query.dnssecE2e array Optional Filters results based on DNSSEC-validated answers by end-to-end security status.
query.dnssecE2e[] boolean Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.matchingAnswer array Optional Filters results based on whether the queries have a matching answer.
query.matchingAnswer[] boolean Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by DNS queries — cloudflare.radar-get-dns-top-locations

Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.domain array Optional Filters results by domain name. When set, no other DNS filter may be used — only date filtering (dateRange, or dateStart/dateEnd) is allowed — and the date range cannot exceed 31 days.
query.domain[] string Optional minLength: 1; maxLength: 253; pattern: "^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$"
query.cacheHit array Optional Filters results based on cache status.
query.cacheHit[] boolean Optional
query.nodata array Optional Specifies whether the response includes empty DNS responses (NODATA). default: ["true"]
query.nodata[] boolean Optional
query.protocol array Optional Filters results by DNS transport protocol.
query.protocol[] string Optional enum: ["UDP","TCP","HTTPS","TLS"]
query.queryType array Optional Filters results by DNS query type.
query.queryType[] string | null Optional enum: ["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"]
query.responseCode array Optional Filters results by DNS response code.
query.responseCode[] string Optional enum: ["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"]
query.responseTtl array Optional Filters results by DNS response TTL.
query.responseTtl[] string Optional enum: ["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"]
query.dnssec array Optional Filters results based on DNSSEC (DNS Security Extensions) support.
query.dnssec[] string Optional enum: ["INVALID","INSECURE","SECURE","OTHER"]
query.dnssecAware array Optional Filters results based on DNSSEC (DNS Security Extensions) client awareness.
query.dnssecAware[] string Optional enum: ["SUPPORTED","NOT_SUPPORTED"]
query.dnssecE2e array Optional Filters results based on DNSSEC-validated answers by end-to-end security status.
query.dnssecE2e[] boolean Optional
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.matchingAnswer array Optional Filters results based on whether the queries have a matching answer.
query.matchingAnswer[] boolean Optional
query.tld array Optional Filters results by top-level domain. Incompatible with the ipVersion, protocol, dnssecE2e, dnssecAware, responseTtl, and cacheHit filters/dimensions; this restriction does not apply to country-code TLDs (2-letter, e.g. uk).
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get email routing summary by dimension — cloudflare.radar-get-email-routing-summary

Retrieves the distribution of email routing metrics by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["IP_VERSION","ENCRYPTED","ARC","DKIM","DMARC","SPF"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.encrypted array Optional Filters results by encryption status (encrypted vs. not-encrypted).
query.encrypted[] string Optional enum: ["ENCRYPTED","NOT_ENCRYPTED"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "IP_VERSION"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get email routing time series grouped by dimension — cloudflare.radar-get-email-routing-timeseries-group

Retrieves the distribution of email routing metrics grouped by dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["IP_VERSION","ENCRYPTED","ARC","DKIM","DMARC","SPF"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.encrypted array Optional Filters results by encryption status (encrypted vs. not-encrypted).
query.encrypted[] string Optional enum: ["ENCRYPTED","NOT_ENCRYPTED"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "IP_VERSION"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get email security summary by dimension — cloudflare.radar-get-email-security-summary

Retrieves the distribution of email security metrics by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["SPAM","MALICIOUS","SPOOF","THREAT_CATEGORY","ARC","DKIM","DMARC","SPF","TLS_VERSION"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "SPAM"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get email security time series grouped by dimension — cloudflare.radar-get-email-security-timeseries-group

Retrieves the distribution of email security metrics grouped by dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["SPAM","MALICIOUS","SPOOF","THREAT_CATEGORY","ARC","DKIM","DMARC","SPF","TLS_VERSION"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "SPAM"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top TLDs by email message volume — cloudflare.radar-get-email-security-top-tlds-by-messages

Retrieves the top TLDs by number of email messages.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"]
query.tldCategory string Optional Filters results by TLD category. enum: ["CLASSIC","COUNTRY"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top TLDs by email malicious classification — cloudflare.radar-get-email-security-top-tlds-by-malicious

Retrieves the top TLDs by emails classified as malicious or not.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.malicious string Required Malicious classification. enum: ["MALICIOUS","NOT_MALICIOUS"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"]
query.tldCategory string Optional Filters results by TLD category. enum: ["CLASSIC","COUNTRY"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "malicious": "MALICIOUS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top TLDs by email spam classification — cloudflare.radar-get-email-security-top-tlds-by-spam

Retrieves the top TLDs by emails classified as spam or not.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.spam string Required Spam classification. enum: ["SPAM","NOT_SPAM"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"]
query.tldCategory string Optional Filters results by TLD category. enum: ["CLASSIC","COUNTRY"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "spam": "SPAM"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top TLDs by email spoof classification — cloudflare.radar-get-email-security-top-tlds-by-spoof

Retrieves the top TLDs by emails classified as spoof or not.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.spoof string Required Spoof classification. enum: ["SPOOF","NOT_SPOOF"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.arc array Optional Filters results by ARC (Authenticated Received Chain) validation.
query.arc[] string Optional enum: ["PASS","NONE","FAIL"]
query.dkim array Optional Filters results by DKIM (DomainKeys Identified Mail) validation status.
query.dkim[] string Optional enum: ["PASS","NONE","FAIL"]
query.dmarc array Optional Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
query.dmarc[] string Optional enum: ["PASS","NONE","FAIL"]
query.spf array Optional Filters results by SPF (Sender Policy Framework) validation status.
query.spf[] string Optional enum: ["PASS","NONE","FAIL"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"]
query.tldCategory string Optional Filters results by TLD category. enum: ["CLASSIC","COUNTRY"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "spoof": "SPOOF"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List autonomous systems — cloudflare.radar-get-entities-asn-list

Retrieves a list of autonomous systems.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.asn string Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list.
query.location string Optional Filters results by location. Specify an alpha-2 location code. minLength: 2; maxLength: 2
query.orderBy string Optional Specifies the metric to order the ASNs by. enum: ["ASN","POPULATION"]; default: "ASN"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AS rankings by botnet threat feed activity — cloudflare.radar-get-as-botnet-threat-feed

Retrieves a ranked list of Autonomous Systems based on their presence in the Cloudflare Botnet Threat Feed. Rankings can be sorted by offense count or number of bad IPs. Optionally compare to a previous date to see rank changes.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.metric string Optional Metric to rank ASNs by. enum: ["OFFENSE_COUNT","NUMBER_OF_OFFENDING_IPS"]; default: "NUMBER_OF_OFFENDING_IPS"
query.date string Optional The date to retrieve (YYYY-MM-DD format). If not specified, returns the most recent available data. Note: This is the date the report was generated. The report is generated from information collected from the previous day (e.g., the 2026-02-23 entry contains data from 2026-02-22). format: "date"
query.compareDateRange string Optional Relative date range for rank change comparison (e.g., "1d", "7d", "30d"). pattern: "^([1-9][0-9]?|[1-9][0-9]{1,2}|3[0-5][0-9]|36[0-4])d|([1-9]|[1-4][0-9]|5[0-2])w$"
query.location string Optional Filters results by location. Specify an alpha-2 location code. minLength: 2; maxLength: 2
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.sortOrder string Optional Sort order. enum: ["ASC","DESC"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AS details by IP address — cloudflare.radar-get-entities-asn-by-ip

Retrieves the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.ip — Required IP address.
query.ip string Required anyOf[1]; format: "ipv4"
query.ip string Required anyOf[2]; format: "ipv6"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "ip": "8.8.8.8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AS details by ASN — cloudflare.radar-get-entities-asn-by-id

Retrieves the requested autonomous system information. (A confidence level below 5 indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asn integer Required Single Autonomous System Number (ASN) as integer.
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asn": 174
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get IRR AS-SETs that an AS is a member of — cloudflare.radar-get-asns-as-set

Retrieves Internet Routing Registry AS-SETs that an AS is a member of.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asn integer Required Retrieves all AS-SETs that the given AS is a member of.
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asn": 3
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get AS-level relationships by ASN — cloudflare.radar-get-asns-rel

Retrieves AS-level relationship for given networks.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asn integer Required Retrieves all ASNs with provider-customer or peering relationships with the given ASN.
query object Optional additionalProperties: false
query.asn2 integer Optional Retrieves the AS relationship of ASN2 with respect to the given ASN.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asn": 3
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get IP address details — cloudflare.radar-get-entities-ip

Retrieves IP address information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.ip — Required IP address.
query.ip string Required anyOf[1]; format: "ipv4"
query.ip string Required anyOf[2]; format: "ipv6"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "ip": "8.8.8.8"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List locations — cloudflare.radar-get-entities-locations

Retrieves a list of locations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.location string Optional Filters results by location. Specify a comma-separated list of alpha-2 location codes.
query.region string Optional Filters results by region. maxLength: 100
query.subregion string Optional Filters results by subregion. maxLength: 100
query.continent string Optional Filters results by continent code. enum: ["AF","AS","EU","NA","OC","SA"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get location details — cloudflare.radar-get-entities-location-by-alpha2

Retrieves the requested location information. (A confidence level below 5 indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.location string Required Location alpha-2 code. minLength: 2; maxLength: 2
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "location": "US"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Geolocations — cloudflare.radar-get-geolocations

Retrieves a list of geolocations. Geolocation names can be localized by sending an Accept-Language HTTP header with a BCP 47 language tag (e.g., Accept-Language: pt-PT). The full quality-value chain is supported (e.g., pt-PT,pt;q=0.9,en;q=0.8).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.geoId string Optional Filters results by geolocation. Specify a comma-separated list of GeoNames IDs.
query.location string Optional Filters results by location. Specify a comma-separated list of alpha-2 location codes.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Geolocation details — cloudflare.radar-get-geolocation-details

Retrieves the requested Geolocation information. Geolocation names can be localized by sending an Accept-Language HTTP header with a BCP 47 language tag (e.g., Accept-Language: pt-PT). The full quality-value chain is supported (e.g., pt-PT,pt;q=0.9,en;q=0.8).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.geo_id string Required Geolocation ID. Refer to GeoNames maxLength: 100
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "geo_id": "3190509"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get HTTP requests summary by dimension — cloudflare.radar-get-http-summary

Retrieves the distribution of HTTP requests by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the HTTP attribute by which to group the results. enum: ["ADM1","API_TRAFFIC","AS","BOT_CLASS","BROWSER","BROWSER_FAMILY","CONTENT_TYPE","DEVICE_TYPE","HTTP_PROTOCOL","HTTP_VERSION","IP_VERSION","LOCATION","OS","POST_QUANTUM","TLS_VERSION"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.apiTraffic array Optional Filters results by API traffic classification. API traffic is identified by JSON or XML response content types on dynamic (non-cacheable) HTTP requests. Incompatible with the browserFamily, deviceType, httpProtocol, httpVersion, ipVersion, os, and tlsVersion filters/dimensions. When set, results can only be further filtered by location, continent, or Autonomous System.
query.apiTraffic[] string Optional enum: ["API","NON_API"]
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.contentType array Optional Filters results by content type category. When set, results can only be further filtered by location, continent, or Autonomous System.
query.contentType[] string Optional enum: ["HTML","IMAGES","JSON","JAVASCRIPT","CSS","PLAIN_TEXT","FONTS","XML","YAML","VIDEO","AUDIO","MARKDOWN","DOCUMENTS","BINARY","SERIALIZATION","OTHER"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "ADM1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get HTTP requests time series — cloudflare.radar-get-http-timeseries

Retrieves the HTTP requests over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE_CHANGE","MIN0_MAX"]
query.apiTraffic array Optional Filters results by API traffic classification. API traffic is identified by JSON or XML response content types on dynamic (non-cacheable) HTTP requests. Incompatible with the browserFamily, deviceType, httpProtocol, httpVersion, ipVersion, os, and tlsVersion filters/dimensions. When set, results can only be further filtered by location, continent, or Autonomous System.
query.apiTraffic[] string Optional enum: ["API","NON_API"]
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.contentType array Optional Filters results by content type category. When set, results can only be further filtered by location, continent, or Autonomous System.
query.contentType[] string Optional enum: ["HTML","IMAGES","JSON","JAVASCRIPT","CSS","PLAIN_TEXT","FONTS","XML","YAML","VIDEO","AUDIO","MARKDOWN","DOCUMENTS","BINARY","SERIALIZATION","OTHER"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get HTTP requests time series grouped by dimension — cloudflare.radar-get-http-timeseries-group

Retrieves the distribution of HTTP requests grouped by dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the HTTP attribute by which to group the results. enum: ["ADM1","API_TRAFFIC","AS","BOT_CLASS","BROWSER","BROWSER_FAMILY","CONTENT_TYPE","DEVICE_TYPE","HTTP_PROTOCOL","HTTP_VERSION","IP_VERSION","LOCATION","OS","POST_QUANTUM","TLS_VERSION"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.apiTraffic array Optional Filters results by API traffic classification. API traffic is identified by JSON or XML response content types on dynamic (non-cacheable) HTTP requests. Incompatible with the browserFamily, deviceType, httpProtocol, httpVersion, ipVersion, os, and tlsVersion filters/dimensions. When set, results can only be further filtered by location, continent, or Autonomous System.
query.apiTraffic[] string Optional enum: ["API","NON_API"]
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.contentType array Optional Filters results by content type category. When set, results can only be further filtered by location, continent, or Autonomous System.
query.contentType[] string Optional enum: ["HTML","IMAGES","JSON","JAVASCRIPT","CSS","PLAIN_TEXT","FONTS","XML","YAML","VIDEO","AUDIO","MARKDOWN","DOCUMENTS","BINARY","SERIALIZATION","OTHER"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["PERCENTAGE","MIN0_MAX"]; default: "PERCENTAGE"
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "ADM1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests — cloudflare.radar-get-http-top-ases-by-http-requests

Retrieves the top autonomous systems by HTTP requests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for a bot class — cloudflare.radar-get-http-top-ases-by-bot-class

Retrieves the top autonomous systems, by HTTP requests, of the requested bot class.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bot_class string Required Bot class. Refer to Bot classes. enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bot_class": "LIKELY_AUTOMATED"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for a browser family — cloudflare.radar-get-http-top-ases-by-browser-family

Retrieves the top autonomous systems, by HTTP requests, of the requested browser family.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.browser_family string Required Browser family. enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "browser_family": "CHROME"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for a device type — cloudflare.radar-get-http-top-ases-by-device-type

Retrieves the top autonomous systems, by HTTP requests, of the requested device type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.device_type string Required Device type. enum: ["DESKTOP","MOBILE","OTHER"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "device_type": "DESKTOP"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for an HTTP protocol — cloudflare.radar-get-http-top-ases-by-http-protocol

Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP protocol.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.http_protocol string Required HTTP protocol (HTTP vs. HTTPS). enum: ["HTTP","HTTPS"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "http_protocol": "HTTP"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for an HTTP version — cloudflare.radar-get-http-top-ases-by-http-version

Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.http_version string Required HTTP version. enum: ["HTTPv1","HTTPv2","HTTPv3"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "http_version": "HTTPv1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for an IP version — cloudflare.radar-get-http-top-ases-by-ip-version

Retrieves the top autonomous systems, by HTTP requests, of the requested IP version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip_version string Required IP version. enum: ["IPv4","IPv6"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip_version": "IPv4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for an OS — cloudflare.radar-get-http-top-ases-by-operating-system

Retrieves the top autonomous systems, by HTTP requests, of the requested operating system.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.os string Required Operating system. enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "os": "WINDOWS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by HTTP requests for a TLS version — cloudflare.radar-get-http-top-ases-by-tls-version

Retrieves the top autonomous systems, by HTTP requests, of the requested TLS protocol version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tls_version string Required TLS version. enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tls_version": "TLSv1_0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests — cloudflare.radar-get-http-top-locations-by-http-requests

Retrieves the top locations by HTTP requests.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for a bot class — cloudflare.radar-get-http-top-locations-by-bot-class

Retrieves the top locations, by HTTP requests, of the requested bot class.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.bot_class string Required Bot class. Refer to Bot classes. enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "bot_class": "LIKELY_AUTOMATED"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for a browser family — cloudflare.radar-get-http-top-locations-by-browser-family

Retrieves the top locations, by HTTP requests, of the requested browser family.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.browser_family string Required Browser family. enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "browser_family": "CHROME"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for a device type — cloudflare.radar-get-http-top-locations-by-device-type

Retrieves the top locations, by HTTP requests, of the requested device type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.device_type string Required Device type. enum: ["DESKTOP","MOBILE","OTHER"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "device_type": "DESKTOP"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for an HTTP protocol — cloudflare.radar-get-http-top-locations-by-http-protocol

Retrieves the top locations, by HTTP requests, of the requested HTTP protocol.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.http_protocol string Required HTTP protocol (HTTP vs. HTTPS). enum: ["HTTP","HTTPS"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "http_protocol": "HTTP"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for an HTTP version — cloudflare.radar-get-http-top-locations-by-http-version

Retrieves the top locations, by HTTP requests, of the requested HTTP version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.http_version string Required HTTP version. enum: ["HTTPv1","HTTPv2","HTTPv3"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "http_version": "HTTPv1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for an IP version — cloudflare.radar-get-http-top-locations-by-ip-version

Retrieves the top locations, by HTTP requests, of the requested IP version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip_version string Required IP version. enum: ["IPv4","IPv6"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip_version": "IPv4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for an OS — cloudflare.radar-get-http-top-locations-by-operating-system

Retrieves the top locations, by HTTP requests, of the requested operating system.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.os string Required Operating system. enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.tlsVersion array Optional Filters results by TLS version.
query.tlsVersion[] string Optional enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "os": "WINDOWS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by HTTP requests for a TLS version — cloudflare.radar-get-http-top-locations-by-tls-version

Retrieves the top locations, by HTTP requests, of the requested TLS protocol version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tls_version string Required TLS version. enum: ["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"]
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.deviceType array Optional Filters results by device type.
query.deviceType[] string Optional enum: ["DESKTOP","MOBILE","OTHER"]
query.httpProtocol array Optional Filters results by HTTP protocol (HTTP vs. HTTPS).
query.httpProtocol[] string Optional enum: ["HTTP","HTTPS"]
query.httpVersion array Optional Filters results by HTTP version.
query.httpVersion[] string Optional enum: ["HTTPv1","HTTPv2","HTTPv3"]
query.ipVersion array Optional Filters results by IP version (Ipv4 vs. IPv6).
query.ipVersion[] string Optional enum: ["IPv4","IPv6"]
query.os array Optional Filters results by operating system.
query.os[] string Optional enum: ["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"]
query.browserFamily array Optional Filters results by browser family.
query.browserFamily[] string Optional enum: ["CHROME","EDGE","FIREFOX","SAFARI"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tls_version": "TLSv1_0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get HTTP authentication requests distribution by dimension — cloudflare.radar-get-leaked-credential-checks-summary

Retrieves an aggregated summary of HTTP authentication requests grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["COMPROMISED","BOT_CLASS"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.compromised array Optional Filters results by compromised credential status (clean vs. compromised).
query.compromised[] string Optional enum: ["CLEAN","COMPROMISED"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "COMPROMISED"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time series distribution of HTTP authentication requests by dimension. — cloudflare.radar-get-leaked-credential-checks-timeseries-group

Retrieves the distribution of HTTP authentication requests, grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the attribute by which to group the results. enum: ["COMPROMISED","BOT_CLASS"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.botClass array Optional Filters results by bot class. Refer to Bot classes.
query.botClass[] string Optional enum: ["LIKELY_AUTOMATED","LIKELY_HUMAN"]
query.compromised array Optional Filters results by compromised credential status (clean vs. compromised).
query.compromised[] string Optional enum: ["CLEAN","COMPROMISED"]
query.checkResult array Optional Filters results by leaked credential check result.
query.checkResult[] string Optional enum: ["CLEAN","USERNAME_LEAKED","USERNAME_PASSWORD_SIMILAR","USERNAME_AND_PASSWORD_LEAKED","PASSWORD_LEAKED"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE_CHANGE","MIN0_MAX"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "COMPROMISED"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get network traffic distribution by dimension — cloudflare.radar-get-netflows-summary

Retrieves the distribution of network traffic (NetFlows) by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the NetFlows attribute by which to group the results. enum: ["ADM1","AS","LOCATION","PRODUCT"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.product array Optional Filters the results by network traffic product types.
query.product[] string Optional enum: ["HTTP","ALL"]
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "ADM1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get network traffic time series — cloudflare.radar-get-netflows-timeseries

Retrieves network traffic (NetFlows) over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.product array Optional Filters the results by network traffic product types.
query.product[] string Optional enum: ["HTTP","ALL"]
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE_CHANGE","MIN0_MAX"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get time series distribution of network traffic by dimension — cloudflare.radar-get-netflows-timeseries-group

Retrieves the distribution of NetFlows traffic, grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the NetFlows attribute by which to group the results. enum: ["ADM1","AS","LOCATION","PRODUCT"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. PERCENTAGE_CHANGE requires exactly one comparison series (e.g. a control date range). enum: ["PERCENTAGE","MIN0_MAX","PERCENTAGE_CHANGE"]; default: "PERCENTAGE"
query.product array Optional Filters the results by network traffic product types.
query.product[] string Optional enum: ["HTTP","ALL"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "ADM1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by network traffic — cloudflare.radar-get-netflows-top-ases

Retrieves the top autonomous systems by network traffic (NetFlows).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by network traffic — cloudflare.radar-get-netflows-top-locations

Retrieves the top locations by network traffic (NetFlows).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.geoId array Optional Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
query.geoId[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Origins — cloudflare.radar-get-origins

Retrieves a list of origins with their regions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get origin metrics distribution by dimension — cloudflare.radar-get-origins-summary

Retrieves an aggregated summary of origin metrics grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the origin attribute by which to group the results. ORIGIN groups across all providers and does not accept an origin or region. REGION requires an origin. SUCCESS_RATE and PERCENTILE require both an origin and a region and constrain the metric (SUCCESS_RATE supports only REQUESTS; PERCENTILE supports any metric except REQUESTS). limitPerGroup is only supported on the REGION dimension. enum: ["ORIGIN","REGION","SUCCESS_RATE","PERCENTILE"]
query object Required additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.origin array Optional Filters results by origin. Required for every dimension except ORIGIN; must not be set on the ORIGIN dimension, which groups across all providers.
query.origin[] string Optional Origins. enum: ["AMAZON","GOOGLE","MICROSOFT","ORACLE"]
query.metric string Required Specifies the metric to retrieve. Allowed metrics depend on the selected dimension (see the dimension path parameter). enum: ["CONNECTION_FAILURES","REQUESTS","RESPONSE_HEADER_RECEIVE_DURATION","TCP_HANDSHAKE_DURATION","TCP_RTT","TLS_HANDSHAKE_DURATION"]
query.region array Optional Filters results by origin region. Requires origin to be set and is validated against it.
query.region[] string Optional maxLength: 100
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "ORIGIN"
  },
  "query": {
    "metric": "REQUESTS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get origin metrics time series — cloudflare.radar-get-origins-timeseries

Retrieves the time series of origin metrics for the specified origin.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.origin array Required Filters results by origin.
query.origin[] string Optional Origins. enum: ["AMAZON","GOOGLE","MICROSOFT","ORACLE"]
query.metric string Required Specifies the metric to retrieve. Without a region, only REQUESTS or CONNECTION_FAILURES are available; specify a region to use the latency metrics. enum: ["CONNECTION_FAILURES","REQUESTS","RESPONSE_HEADER_RECEIVE_DURATION","TCP_HANDSHAKE_DURATION","TCP_RTT","TLS_HANDSHAKE_DURATION"]
query.region array Optional Filters results by origin region. Requires origin to be set and is validated against it.
query.region[] string Optional maxLength: 100
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "origin": [
      "AMAZON"
    ],
    "metric": "REQUESTS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get origin metrics time series grouped by dimension — cloudflare.radar-get-origins-timeseries-group

Retrieves the distribution of origin metrics grouped by the specified dimension over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the origin attribute by which to group the results. ORIGIN groups across all providers and does not accept an origin or region. REGION requires an origin. SUCCESS_RATE and PERCENTILE require both an origin and a region and constrain the metric (SUCCESS_RATE supports only REQUESTS; PERCENTILE supports any metric except REQUESTS). limitPerGroup is only supported on the REGION dimension. enum: ["ORIGIN","REGION","SUCCESS_RATE","PERCENTILE"]
query object Required additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.origin array Optional Filters results by origin. Required for every dimension except ORIGIN; must not be set on the ORIGIN dimension, which groups across all providers.
query.origin[] string Optional Origins. enum: ["AMAZON","GOOGLE","MICROSOFT","ORACLE"]
query.metric string Required Specifies the metric to retrieve. Allowed metrics depend on the selected dimension (see the dimension path parameter). enum: ["CONNECTION_FAILURES","REQUESTS","RESPONSE_HEADER_RECEIVE_DURATION","TCP_HANDSHAKE_DURATION","TCP_RTT","TLS_HANDSHAKE_DURATION"]
query.region array Optional Filters results by origin region. Requires origin to be set and is validated against it.
query.region[] string Optional maxLength: 100
query.normalization string Optional Normalization method applied to the results. Refer to Normalization methods. enum: ["PERCENTAGE","MIN0_MAX"]; default: "PERCENTAGE"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "ORIGIN"
  },
  "query": {
    "metric": "REQUESTS"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Origin Post-Quantum Data Summary — cloudflare.radar-get-origin-post-quantum-summary

Returns a summary of origin post-quantum data grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the origin post-quantum data dimension by which to group the results. enum: ["KEY_AGREEMENT"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "KEY_AGREEMENT"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Origin Post-Quantum Data Over Time — cloudflare.radar-get-origin-post-quantum-timeseries-groups

Returns a timeseries of origin post-quantum data grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Specifies the origin post-quantum data dimension by which to group the results. enum: ["KEY_AGREEMENT"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "KEY_AGREEMENT"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check Post-Quantum TLS support — cloudflare.radar-get-post-quantum-tls-support

Tests whether a hostname or IP address supports Post-Quantum (PQ) TLS key exchange. Returns information about the negotiated key exchange algorithm, whether it uses PQ cryptography, and any detected TLS implementation bugs (Split ClientHello, HRR failure, etc.).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.host string Required Hostname or IP address to test for Post-Quantum TLS support, optionally with port (defaults to 443). minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "host": "cloudflare.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get speed tests histogram — cloudflare.radar-get-quality-speed-histogram

Retrieves a histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms), or jitter (ms) buckets.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.bucketSize integer Optional Specifies the width for every bucket in the histogram.
query.metricGroup string Optional Metrics to be returned. enum: ["BANDWIDTH","LATENCY","JITTER"]; default: "bandwidth"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get speed tests summary — cloudflare.radar-get-quality-speed-summary

Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the previous 90 days of Cloudflare Speed Test data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top ASes by speed test results — cloudflare.radar-get-quality-speed-top-ases

Retrieves the top autonomous systems by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.orderBy string Optional Specifies the metric to order the results by. enum: ["BANDWIDTH_DOWNLOAD","BANDWIDTH_UPLOAD","LATENCY_IDLE","LATENCY_LOADED","JITTER_IDLE","JITTER_LOADED"]; default: "BANDWIDTH_DOWNLOAD"
query.reverse boolean Optional Reverses the order of results.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by speed test results — cloudflare.radar-get-quality-speed-top-locations

Retrieves the top locations by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.orderBy string Optional Specifies the metric to order the results by. enum: ["BANDWIDTH_DOWNLOAD","BANDWIDTH_UPLOAD","LATENCY_IDLE","LATENCY_LOADED","JITTER_IDLE","JITTER_LOADED"]; default: "BANDWIDTH_DOWNLOAD"
query.reverse boolean Optional Reverses the order of results.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get domain rank details — cloudflare.radar-get-ranking-domain-details

Retrieves domain rank details. Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain string Required Domain name. pattern: "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][a-zA-Z0-9-]*[A-Za-z0-9])$"
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.rankingType string Optional The ranking type. enum: ["POPULAR","TRENDING_RISE","TRENDING_STEADY"]; default: "POPULAR"
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.includeTopLocations boolean Optional Includes top locations in the response.
query.date array Optional Filters results by the specified array of dates.
query.date[] string Optional format: "date"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain": "google.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Internet services categories — cloudflare.radar-get-ranking-internet-services-categories

Retrieves the list of Internet services categories.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response.
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.date array Optional Filters results by the specified array of dates.
query.date[] string Optional format: "date"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Internet services rank time series — cloudflare.radar-get-ranking-internet-services-timeseries

Retrieves Internet Services rank update changes over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.serviceCategory array Optional Filters results by Internet service category.
query.serviceCategory[] string Optional maxLength: 100
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top Internet services — cloudflare.radar-get-ranking-top-internet-services

Retrieves top Internet services based on their rank.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.serviceCategory array Optional Filters results by Internet service category.
query.serviceCategory[] string Optional maxLength: 100
query.limit integer Optional Limits the number of objects returned in the response.
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.date array Optional Filters results by the specified array of dates.
query.date[] string Optional format: "date"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get domains rank time series — cloudflare.radar-get-ranking-domain-timeseries

Retrieves domains rank over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.rankingType string Optional The ranking type. enum: ["POPULAR","TRENDING_RISE","TRENDING_STEADY"]; default: "POPULAR"
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 location codes.
query.location[] string Optional
query.domains array Optional Filters results by domain name. Specify a comma-separated list of domain names.
query.domains[] string Optional minLength: 1; maxLength: 253; pattern: "^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$"
query.domainCategory array Optional Filters results by domain category.
query.domainCategory[] string Optional maxLength: 100
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top or trending domains — cloudflare.radar-get-ranking-top-domains

Retrieves the top or trending domains based on their rank. Popular domains are domains of broad appeal based on how people use the Internet. Trending domains are domains that are generating a surge in interest. For more information on top domains, see https://blog.cloudflare.com/radar-domain-rankings/.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response.
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 location codes.
query.location[] string Optional
query.domainCategory array Optional Filters results by domain category.
query.domainCategory[] string Optional maxLength: 100
query.date array Optional Filters results by the specified array of dates.
query.date[] string Optional format: "date"
query.rankingType string Optional The ranking type. enum: ["POPULAR","TRENDING_RISE","TRENDING_STEADY"]; default: "POPULAR"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top domain categories by robots.txt files parsed — cloudflare.radar-get-robots-txt-top-domain-categories-by-files-parsed

Retrieves the top domain categories by the number of robots.txt files parsed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.userAgentCategory string Optional Filters results by user agent category. enum: ["AI"]; default: "AI"
query.date array Optional Filters results by the specified array of dates.
query.date[] string Optional format: "date"
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top user agents on robots.txt files — cloudflare.radar-get-robots-txt-top-user-agents-by-directive

Retrieves the top user agents on robots.txt files.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.userAgentCategory string Optional Filters results by user agent category. enum: ["AI"]; default: "AI"
query.date array Optional Filters results by the specified array of dates.
query.date[] string Optional format: "date"
query.domainCategory array Optional Filters results by domain category.
query.domainCategory[] string Optional maxLength: 100
query.directive string Optional Filters results by robots.txt directive. enum: ["ALLOW","DISALLOW"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search for locations, ASes, reports, and more — cloudflare.radar-get-search-global

Searches for locations, autonomous systems, reports, bots, certificate logs, certificate authorities, industries and verticals. Location names can be localized by sending an Accept-Language HTTP header with a BCP 47 language tag (e.g., Accept-Language: pt-PT). The full quality-value chain is supported (e.g., pt-PT,pt;q=0.9,en;q=0.8).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.limitPerGroup number Optional Limits the number of objects per search category.
query.query string Required String used to perform the search operation.
query.include array Optional Search types included in results.
query.include[] string Optional enum: ["ADM1S","ASNS","BOTS","CERTIFICATE_AUTHORITIES","CERTIFICATE_LOGS","ORIGINS","ORIGIN_REGIONS","INDUSTRIES","LOCATIONS","NOTEBOOKS","TLDS","VERTICALS"]
query.exclude array Optional Search types excluded from results.
query.exclude[] string Optional enum: ["ADM1S","ASNS","BOTS","CERTIFICATE_AUTHORITIES","CERTIFICATE_LOGS","ORIGINS","ORIGIN_REGIONS","INDUSTRIES","LOCATIONS","NOTEBOOKS","TLDS","VERTICALS"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "query": "United"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TCP resets and timeouts summary — cloudflare.radar-get-tcp-resets-timeouts-summary

Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TCP resets and timeouts time series — cloudflare.radar-get-tcp-resets-timeouts-timeseries-group

Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.asn array Optional Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
query.asn[] string Optional
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List TLDs — cloudflare.radar-get-tlds

Retrieves a list of TLDs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.tldManager string Optional Filters results by TLD manager. maxLength: 100
query.tldType string Optional Filters results by TLD type. GENERIC_RESTRICTED and SPONSORED are deprecated and return no results, as IANA consolidated them into GENERIC. INFRASTRUCTURE is deprecated, as IANA reclassified .arpa as SPECIAL_USE. enum: ["GENERIC","COUNTRY_CODE","SPECIAL_USE","GENERIC_RESTRICTED","INFRASTRUCTURE","SPONSORED"]
query.tld string Optional Filters results by top-level domain. Specify a comma-separated list of TLDs.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TLD Performance Summary — cloudflare.radar-get-tlds-performance-summary

Returns a summary of TLD authoritative nameserver performance grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Dimension to summarize TLD nameserver latency by. enum: ["LATENCY","NAMESERVER_LATENCY","LOCATION_LATENCY"]
query object Optional additionalProperties: false
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.tld array Optional Filters results by top-level domain.
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.nameserver string Optional Filters results by nameserver hostname. minLength: 1; maxLength: 253; pattern: "^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "LATENCY"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TLD Performance Over Time — cloudflare.radar-get-tlds-performance-timeseries-groups

Returns a timeseries of TLD authoritative nameserver performance grouped by the specified dimension.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dimension string Required Dimension for the TLD nameserver latency timeseries. enum: ["LATENCY","NAMESERVER_LATENCY","LOCATION_LATENCY"]
query object Optional additionalProperties: false
query.aggInterval string Optional Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected. enum: ["15m","1h","1d","1w"]
query.name array Optional Array of names used to label the series in the response.
query.name[] string Optional
query.dateRange array Optional Filters results by relative date range ending at the current time, with each value producing a separate series. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).
query.dateRange[] string Optional pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart array Optional Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateStart[] string Optional format: "date-time"
query.dateEnd array Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
query.dateEnd[] string Optional format: "date-time"
query.location array Optional Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.
query.location[] string Optional
query.continent array Optional Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.
query.continent[] string Optional
query.tld array Optional Filters results by top-level domain.
query.tld[] string Optional minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query.nameserver string Optional Filters results by nameserver hostname. minLength: 1; maxLength: 253; pattern: "^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$"
query.limitPerGroup integer Optional Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dimension": "LATENCY"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TLD details — cloudflare.radar-get-tld-details

Retrieves the requested TLD information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tld string Required Top-level domain. minLength: 2; maxLength: 63; pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$"
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tld": "com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get latest Internet traffic anomalies — cloudflare.radar-get-traffic-anomalies

Retrieves the latest Internet traffic anomalies, which are signals that might indicate an outage. These alerts are automatically detected by Radar and manually verified by our team.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.offset integer Optional Skips the specified number of objects before fetching the results. minimum: 0
query.dateRange string Optional Filters results by a relative date range ending at the current time. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd. pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.status string Optional enum: ["VERIFIED","UNVERIFIED"]
query.type array Optional Filters results by entity type (LOCATION, AS, or ORIGIN).
query.type[] string Optional enum: ["LOCATION","AS","ORIGIN"]
query.dataSource string Optional Filters results by data source. enum: ["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"]
query.asn integer Optional Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
query.location string Optional Filters results by location. Specify an alpha-2 location code. minLength: 2; maxLength: 2
query.origin string Optional Filters results by origin. maxLength: 100
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get top locations by total traffic anomalies — cloudflare.radar-get-traffic-anomalies-top

Retrieves the sum of Internet traffic anomalies, grouped by location. These anomalies are signals that might indicate an outage, automatically detected by Radar and manually verified by our team.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of objects returned in the response. default: 5; exclusiveMinimum: 0
query.dateRange string Optional Filters results by a relative date range ending at the current time. Use &lt;n&gt;d for days (up to 364d) or &lt;n&gt;w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd. pattern: "^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$"
query.dateStart string Optional Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd. format: "date-time"
query.dateEnd string Optional End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. format: "date-time"
query.status string Optional enum: ["VERIFIED","UNVERIFIED"]
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get traffic anomaly by UUID — cloudflare.radar-get-traffic-anomaly-by-uuid

Retrieves a single Internet traffic anomaly by UUID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.uuid string Required Traffic anomaly UUID. pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
query object Optional additionalProperties: false
query.format string Optional Format in which results will be returned. enum: ["JSON","CSV"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "uuid": "b1bcd2c3-4cf0-4dad-b90f-719388bf6460"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tenant accounts — cloudflare.tenants_listaccounts

Lists all Cloudflare accounts across this tenant's hierarchy using the legacy Account response shape. Use GET /organizations/{organization_id}/accounts to list only accounts immediately attached to a specific Organization using the modern Account response shape. Use page_token and page_size for cursor pagination, or provide page and per_page together for legacy offset pagination. Cursor pagination takes precedence when requested.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tenant_id string Required The ID of the tenant whose accounts to list.
query object Optional additionalProperties: false
query.account_pubname string Optional (case-sensitive) Filter the list of accounts to where the account_pubname is equal to a particular string.
query.account_pubname.startsWith string Optional (case-insensitive) Filter the list of accounts to where the account_pubname starts with a particular string.
query.account_pubname.endsWith string Optional (case-insensitive) Filter the list of accounts to where the account_pubname ends with a particular string.
query.account_pubname.contains string Optional (case-insensitive) Filter the list of accounts to where the account_pubname contains a particular string.
query.name string Optional (case-sensitive) Filter the list of accounts to where the name is equal to a particular string. At most one of name, name.startsWith, name.endsWith, or name.contains may be supplied per request.
query.name.startsWith string Optional (case-insensitive) Filter the list of accounts to where the name starts with a particular string.
query.name.endsWith string Optional (case-insensitive) Filter the list of accounts to where the name ends with a particular string.
query.name.contains string Optional (case-insensitive) Filter the list of accounts to where the name contains a particular string.
query.status string Optional Filter accounts by lifecycle status. Defaults to active. enum: ["active","deleted"]
query.order_by string Optional Field to order results by. Currently supported values: account_name. enum: ["account_name"]
query.direction string Optional Sort direction for the order_by field. Valid values: asc, desc. Defaults to asc when order_by is specified. enum: ["asc","desc"]
query.include_total boolean Optional Whether to calculate and return the exact result_info.total_size for cursor pagination. Defaults to true. When false, total_size is omitted. Legacy page/per_page requests always calculate total_count. default: true
query.page integer Optional Legacy offset page number. Must be provided with per_page. Values below 1 are treated as 1. Cursor pagination takes precedence when requested.
query.per_page integer Optional Legacy offset page size. Must be provided with page. Values are clamped to the range 1-100. Cursor pagination takes precedence when requested.
query.page_token string Optional An opaque token returned from the last list response that when provided will retrieve the next page. Parameters used to filter the retrieved list must remain in subsequent requests with a page token.
query.page_size integer Optional The amount of items to return. Defaults to 10. minimum: 0; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tenant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Tenant Custom Nameservers — cloudflare.tenant-level-custom-nameservers-list-tenant-custom-nameservers

Lists a tenant's custom nameservers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tenant_id — Required $ref: "#/definitions/dns-custom-nameservers_identifier-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tenant_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Tenant Custom Nameserver — cloudflare.tenant-level-custom-nameservers-add-tenant-custom-nameserver

Adds a custom nameserver for a tenant.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.tenant_id — Required $ref: "#/definitions/dns-custom-nameservers_identifier-3"
body — Required $ref: "#/definitions/dns-custom-nameservers_CustomNSInput"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "tenant_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "ns_name": "ns1.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Tenant Custom Nameserver — cloudflare.tenant-level-custom-nameservers-delete-tenant-custom-nameserver

Deletes a tenant's custom nameserver.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_ns_id — Required $ref: "#/definitions/dns-custom-nameservers_ns_name"
path.tenant_id — Required $ref: "#/definitions/dns-custom-nameservers_identifier-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_ns_id": "ns1.example.com",
    "tenant_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

User Details — cloudflare.user-user-details

Retrieves detailed information about the currently authenticated user, including email, name, and account memberships.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit User — cloudflare.user-edit-user

Edit part of your user details.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.country — Optional $ref: "#/definitions/iam_country"
body.first_name — Optional $ref: "#/definitions/iam_first_name"
body.last_name — Optional $ref: "#/definitions/iam_last_name"
body.telephone — Optional $ref: "#/definitions/iam_telephone"
body.zipcode — Optional $ref: "#/definitions/iam_zipcode"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get count of zones with Argo Smart Routing enabled for user — cloudflare.argo-smart-routing-get-count-zones-enabled-for-user

Returns the number of zones that have Argo Smart Routing enabled for the authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get user audit logs — cloudflare.audit-logs-get-user-audit-logs

Gets a list of audit logs for a user account. Can be filtered by who made the change, on which zone, and the timeframe of the change.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.id string Optional Finds a specific log by its ID.
query.export boolean Optional Indicates that this request is an export of logs in CSV format.
query.action.type string Optional Filters by the action type.
query.actor.ip string Optional Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.
query.actor.email string Optional Filters by the email address of the actor that made the change. format: "email"
query.since — Optional
query.since string Optional Limits the returned results to logs newer than the specified date. A full-date that conforms to RFC3339. oneOf[1]; format: "date"
query.since string Optional Limits the returned results to logs newer than the specified date. A date-time that conforms to RFC3339. oneOf[2]; format: "date-time"
query.before — Optional
query.before string Optional Limits the returned results to logs older than the specified date. A full-date that conforms to RFC3339. oneOf[1]; format: "date"
query.before string Optional Limits the returned results to logs older than the specified date. A date-time that conforms to RFC3339. oneOf[2]; format: "date-time"
query.zone.name string Optional Filters by the name of the zone associated to the change.
query.direction string Optional Changes the direction of the chronological sorting. enum: ["desc","asc"]; default: "desc"
query.per_page number Optional Sets the number of results to return per page. default: 100; minimum: 1; maximum: 1000
query.page number Optional Defines which page of results to return. default: 1; minimum: 1
query.hide_user_logs boolean Optional Indicates whether or not to hide user level audit logs. default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get communication preferences — cloudflare.user-communication-preferences-get

Retrieve the communication preferences for the authenticated user, including email verification status, marketing subscription opt-in/opt-out state, and language locale. Callers authenticate with standard Cloudflare API tokens or keys.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update communication preferences — cloudflare.user-communication-preferences-update

Set one or more communication preferences for the authenticated user. Supply a map of preference keys to subscription states, and an optional language locale. This endpoint does not modify email verification settings. Callers authenticate with standard Cloudflare API tokens or keys.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/cps_update_communication_preferences_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IP Access rules — cloudflare.ip-access-rules-for-a-user-list-ip-access-rules

Fetches IP Access rules of the user. You can filter the results using several optional parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.mode — Optional $ref: "#/definitions/firewall_schemas-mode"
query.configuration.target string Optional Defines the target to search in existing rules. enum: ["ip","ip_range","asn","country"]
query.configuration.value string Optional Defines the target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided configuration.target. Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
query.notes string Optional Defines the string to search for in the notes of existing IP Access rules. Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
query.match string Optional Defines the search requirements. When set to all, all the search requirements must match. When set to any, only one of the search requirements has to match. enum: ["any","all"]; default: "all"
query.page number Optional Defines the requested page within paginated list of results.
query.per_page number Optional Defines the maximum number of results requested.
query.order string Optional Defines the field used to sort returned rules. enum: ["configuration.target","configuration.value","mode"]
query.direction string Optional Defines the direction used to sort returned rules. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an IP Access rule — cloudflare.ip-access-rules-for-a-user-delete-an-ip-access-rule

Deletes an IP Access rule at the user level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/firewall_rule_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an IP Access rule — cloudflare.ip-access-rules-for-a-user-get-an-ip-access-rule

Fetches the details of an IP Access rule defined at the user level.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/firewall_rule_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an IP Access rule — cloudflare.ip-access-rules-for-a-user-update-an-ip-access-rule

Updates an IP Access rule defined at the user level. You can only update the rule action (mode parameter) and notes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/firewall_rule_identifier"
body object Required
body.mode — Optional
body.mode — Optional allOf[1]; $ref: "#/definitions/firewall_schemas-mode"
body.notes — Optional $ref: "#/definitions/firewall_notes"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Invitations — cloudflare.user--s-invites-list-invitations

Lists all invitations associated with my user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Invitation Details — cloudflare.user--s-invites-invitation-details

Gets the details of an invitation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.invite_id — Required $ref: "#/definitions/iam_invite_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "invite_id": "4f5f0c14a2a41d5063dd301b2f829f04"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Respond to Invitation — cloudflare.user--s-invites-respond-to-invitation

Responds to an invitation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.invite_id — Required $ref: "#/definitions/iam_invite_components-schemas-identifier"
body object Required
body.status string Required Status of your response to the invitation (rejected or accepted). enum: ["accepted","rejected"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "invite_id": "4f5f0c14a2a41d5063dd301b2f829f04"
  },
  "body": {
    "status": "accepted"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Monitors — cloudflare.load-balancer-monitors-list-monitors

List configured monitors for a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Monitor — cloudflare.load-balancer-monitors-create-monitor

Create a configured monitor.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Monitor — cloudflare.load-balancer-monitors-delete-monitor

Delete a configured monitor.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Monitor Details — cloudflare.load-balancer-monitors-monitor-details

Fetch a single configured monitor for a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Monitor — cloudflare.load-balancer-monitors-patch-monitor

Apply changes to an existing monitor, overwriting the supplied properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Monitor — cloudflare.load-balancer-monitors-update-monitor

Modify a configured monitor.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview Monitor — cloudflare.load-balancer-monitors-preview-monitor

Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Monitor References — cloudflare.load-balancer-monitors-list-monitor-references

Get the list of resources that reference the provided monitor.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.monitor_id — Required $ref: "#/definitions/load-balancing_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "monitor_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Pools — cloudflare.load-balancer-pools-list-pools

List configured pools.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.monitor string Optional The ID of the Monitor to use for checking the health of origins within this pool.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Pools — cloudflare.load-balancer-pools-patch-pools

Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending name. Returns the list of affected pools. Supports the standard pagination query parameters, either limit/offset or per_page/page.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.notification_email — Optional $ref: "#/definitions/load-balancing_patch_pools_notification_email"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Pool — cloudflare.load-balancer-pools-create-pool

Create a new pool.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.check_regions — Optional $ref: "#/definitions/load-balancing_check_regions"
body.description — Optional $ref: "#/definitions/load-balancing_schemas-description"
body.enabled — Optional $ref: "#/definitions/load-balancing_enabled"
body.health_sources — Optional $ref: "#/definitions/load-balancing_health_sources"
body.latitude — Optional $ref: "#/definitions/load-balancing_latitude"
body.load_shedding — Optional $ref: "#/definitions/load-balancing_load_shedding"
body.longitude — Optional $ref: "#/definitions/load-balancing_longitude"
body.minimum_origins — Optional $ref: "#/definitions/load-balancing_minimum_origins"
body.monitor — Optional $ref: "#/definitions/load-balancing_monitor_id"
body.monitor_group — Optional $ref: "#/definitions/load-balancing_monitor_group_id"
body.name — Required $ref: "#/definitions/load-balancing_name"
body.networks — Optional $ref: "#/definitions/load-balancing_networks"
body.notification_email — Optional $ref: "#/definitions/load-balancing_notification_email"
body.notification_filter — Optional $ref: "#/definitions/load-balancing_notification_filter"
body.origin_steering — Optional $ref: "#/definitions/load-balancing_origin_steering"
body.origins — Required $ref: "#/definitions/load-balancing_origins"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "origins": [],
    "name": "primary-dc-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Pool — cloudflare.load-balancer-pools-delete-pool

Delete a configured pool.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pool Details — cloudflare.load-balancer-pools-pool-details

Fetch a single configured pool.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Pool — cloudflare.load-balancer-pools-patch-pool

Apply changes to an existing pool, overwriting the supplied properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
body object Required
body.check_regions — Optional $ref: "#/definitions/load-balancing_check_regions"
body.description — Optional $ref: "#/definitions/load-balancing_schemas-description"
body.disabled_at — Optional $ref: "#/definitions/load-balancing_schemas-disabled_at"
body.enabled — Optional $ref: "#/definitions/load-balancing_enabled"
body.health_sources — Optional $ref: "#/definitions/load-balancing_health_sources"
body.latitude — Optional $ref: "#/definitions/load-balancing_latitude"
body.load_shedding — Optional $ref: "#/definitions/load-balancing_load_shedding"
body.longitude — Optional $ref: "#/definitions/load-balancing_longitude"
body.minimum_origins — Optional $ref: "#/definitions/load-balancing_minimum_origins"
body.monitor — Optional $ref: "#/definitions/load-balancing_monitor_id"
body.monitor_group — Optional $ref: "#/definitions/load-balancing_monitor_group_id"
body.name — Optional $ref: "#/definitions/load-balancing_name"
body.notification_email — Optional $ref: "#/definitions/load-balancing_notification_email"
body.notification_filter — Optional $ref: "#/definitions/load-balancing_notification_filter"
body.origin_steering — Optional $ref: "#/definitions/load-balancing_origin_steering"
body.origins — Optional $ref: "#/definitions/load-balancing_origins"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Pool — cloudflare.load-balancer-pools-update-pool

Modify a configured pool.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
body object Required
body.check_regions — Optional $ref: "#/definitions/load-balancing_check_regions"
body.description — Optional $ref: "#/definitions/load-balancing_schemas-description"
body.disabled_at — Optional $ref: "#/definitions/load-balancing_schemas-disabled_at"
body.enabled — Optional $ref: "#/definitions/load-balancing_enabled"
body.health_sources — Optional $ref: "#/definitions/load-balancing_health_sources"
body.latitude — Optional $ref: "#/definitions/load-balancing_latitude"
body.load_shedding — Optional $ref: "#/definitions/load-balancing_load_shedding"
body.longitude — Optional $ref: "#/definitions/load-balancing_longitude"
body.minimum_origins — Optional $ref: "#/definitions/load-balancing_minimum_origins"
body.monitor — Optional $ref: "#/definitions/load-balancing_monitor_id"
body.monitor_group — Optional $ref: "#/definitions/load-balancing_monitor_group_id"
body.name — Required $ref: "#/definitions/load-balancing_name"
body.networks — Optional $ref: "#/definitions/load-balancing_networks"
body.notification_email — Optional $ref: "#/definitions/load-balancing_notification_email"
body.notification_filter — Optional $ref: "#/definitions/load-balancing_notification_filter"
body.origin_steering — Optional $ref: "#/definitions/load-balancing_origin_steering"
body.origins — Required $ref: "#/definitions/load-balancing_origins"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4"
  },
  "body": {
    "origins": [],
    "name": "primary-dc-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Pool Health Details — cloudflare.load-balancer-pools-pool-health-details

Fetch the latest pool health status for a single pool.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview Pool — cloudflare.load-balancer-pools-preview-pool

Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"
body — Required
body — Required allOf[1]; $ref: "#/definitions/load-balancing_monitor-editable"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Pool References — cloudflare.load-balancer-pools-list-pool-references

Get the list of resources that reference the provided pool.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_id — Required $ref: "#/definitions/load-balancing_schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview Result — cloudflare.load-balancer-monitors-preview-result

Get the result of a previous preview operation using the provided preview_id.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.preview_id — Required $ref: "#/definitions/load-balancing_preview_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Regions — cloudflare.user-load-balancer-regions-list-regions

List all region mappings in the user context.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.subdivision_code — Optional $ref: "#/definitions/load-balancing_subdivision_code_a2"
query.country_code string Optional Two-letter alpha-2 country code as defined in ISO 3166-1.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Healthcheck Events — cloudflare.load-balancer-healthcheck-events-list-healthcheck-events

List origin health changes.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.until — Optional $ref: "#/definitions/load-balancing_until"
query.pool_name — Optional $ref: "#/definitions/load-balancing_pool_name"
query.origin_healthy — Optional $ref: "#/definitions/load-balancing_origin_healthy"
query.pool_id — Optional $ref: "#/definitions/load-balancing_schemas-identifier"
query.since string Optional Start date and time of requesting data period in the ISO8601 format. format: "date-time"
query.origin_name string Optional The name for the origin to filter.
query.pool_healthy boolean Optional If true, filter events where the pool status is healthy. If false, filter events where the pool status is unhealthy. default: true

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get User Membership — cloudflare.user-memberships-get

Get a specific membership for the currently authenticated user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.membership_id — Required $ref: "#/definitions/iam_membership_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "membership_id": "4536bcfad5faccb111b47003c79917fa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get zones bandwidth report — cloudflare.spectrum-analytics-get-zones-report

Retrieves a list of total bandwidth by zone over a given time period.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.since — Optional $ref: "#/definitions/spectrum-analytics_since"
query.until — Optional $ref: "#/definitions/spectrum-analytics_until"
query.cdn_traffic boolean Optional Include CDN traffic in the bandwidth aggregation. default: true

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get User Subscriptions — cloudflare.user-subscription-get-user-subscriptions

Lists all of a user's subscriptions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create User Subscription — cloudflare.user-subscription-create-user-subscription

Creates a user subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete User Subscription — cloudflare.user-subscription-delete-user-subscription

Deletes a user's subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "506e3185e9c882d175a2d0cb0093d9f2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update User Subscription — cloudflare.user-subscription-update-user-subscription

Updates a user's subscriptions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/bill-subs-api_schemas-identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "506e3185e9c882d175a2d0cb0093d9f2"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List user tenants — cloudflare.user_listusertenants

Lists the Cloudflare tenants in which the authenticated user has direct membership using the legacy Tenant response shape. Use GET /organizations to list Organizations the user can access, including through hierarchy, using the modern Organization response shape.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Tokens — cloudflare.user-api-tokens-list-tokens

List all access tokens you created. Results include active, disabled, and recently-expired tokens when include_expired is set to true.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.include_expired boolean Optional When true, includes recently-expired tokens in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Token — cloudflare.user-api-tokens-create-token

Create a new access token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/iam_create_payload"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "readonly token",
    "policies": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Token Permission Groups — cloudflare.permission-groups-list-permission-groups

Find all available permission groups for API Tokens.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name string Optional Filter by the name of the permission group. The value must be URL-encoded.
query.scope string Optional Filter by the scope of the permission group. The value must be URL-encoded.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Verify Token — cloudflare.user-api-tokens-verify-token

Test whether a token works.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Token — cloudflare.user-api-tokens-delete-token

Destroy a token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.token_id — Required $ref: "#/definitions/iam_token_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "token_id": "ed17574386854bf78a67040be0a770b0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Token Details — cloudflare.user-api-tokens-token-details

Get information about a specific token.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.token_id — Required $ref: "#/definitions/iam_token_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "token_id": "ed17574386854bf78a67040be0a770b0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Roll Token — cloudflare.user-api-tokens-roll-token

Roll the token secret.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.token_id — Required $ref: "#/definitions/iam_token_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "token_id": "ed17574386854bf78a67040be0a770b0"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request domain connect validation — cloudflare.postverify

Validates a Domain Connect signed request using DNS TXT public keys.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/domain-connect_PostData"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Serve a provider template — cloudflare.getprovidertemplate

Providers are the external parties that are configured to interact with Cloudflare.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.provider string Required Provider name.
path.service string Required Service name.
query object Optional additionalProperties: false
query.dump string Optional Dump raw template.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "provider": "example",
    "service": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Serve a provider configuration — cloudflare.getproviderconfiguration

Provides Stratus with extra information about domain connect provider(s).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.provider string Required Provider ID.
path.service string Required Service ID.
path.account string Required Account ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "provider": "example",
    "service": "example",
    "account": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Provide settings if domain is served by Cloudflare — cloudflare.getdomainsettings

Checks whether a domain is in Quicksilver and returns its settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain string Required Domain name.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger deploy hook — cloudflare.triggerdeployhook

Trigger a build using a deploy hook. This endpoint does not require authentication - the deploy_hook_uuid acts as a secret token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_hook_uuid — Required Deploy hook UUID $ref: "#/definitions/builds_deploy_hook_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_hook_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zones — cloudflare.zones-get

Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name string Optional 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 maxLength: 253
query.status string Optional Specify a zone status to filter by. enum: ["initializing","pending","active","moved"]
query.type array Optional 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.
query.type[] string Optional enum: ["full","partial","secondary","internal"]
query.account.id string Optional Filter by an account ID.
query.account.name string Optional 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 maxLength: 253
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of zones per page. default: 20; minimum: 5; maximum: 50
query.order string Optional Field to order zones by. enum: ["name","status","account.id","account.name","plan.id"]
query.direction string Optional Direction to order zones. enum: ["asc","desc"]
query.match string Optional Whether to match all search requirements or at least one (any). enum: ["any","all"]; default: "all"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Zone — cloudflare.zones-post

Creates a new zone (domain) in your Cloudflare account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.account object Required
body.account.id — Optional $ref: "#/definitions/zones_identifier"
body.name — Required $ref: "#/definitions/zones_name"
body.type — Optional $ref: "#/definitions/zones_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "example.com",
    "account": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Zone — cloudflare.zones-0-delete

Deletes an existing zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zones_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Zone Details — cloudflare.zones-0-get

Retrieves detailed information about a specific zone identified by its zone ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zones_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Zone — cloudflare.zones-0-patch

Edits a zone. Only one zone property can be changed at a time.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zones_identifier"
body object Required
body.paused — Optional $ref: "#/definitions/zones_paused"
body.plan object Optional (Deprecated) Please use the /zones/{zone_id}/subscription API to update a zone's plan. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans.
body.plan.id — Optional $ref: "#/definitions/zones_identifier"
body.type string Optional A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone. enum: ["full","partial","secondary","internal"]
body.vanity_name_servers — Optional $ref: "#/definitions/zones_vanity_name_servers"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "paused": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access Applications — cloudflare.zone-level-access-applications-list-access-applications

List all Access Applications in a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an Access application — cloudflare.zone-level-access-applications-add-a-bookmark-application

Adds a new application to Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_apps"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "self_hosted",
    "domain": "test.example.com/admin"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List short-lived certificate CAs — cloudflare.zone-level-access-short-lived-certificate-c-as-list-short--22caea06d1

Lists short-lived certificate CAs and their public keys.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a short-lived certificate CA — cloudflare.zone-level-access-short-lived-certificate-c-as-delete-a-sh-a8831aa1dd

Deletes a short-lived certificate CA.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a short-lived certificate CA — cloudflare.zone-level-access-short-lived-certificate-c-as-get-a-short-eaf60afb56

Fetches a short-lived certificate CA and its public key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a short-lived certificate CA — cloudflare.zone-level-access-short-lived-certificate-c-as-create-a-sh-7a27acdb55

Generates a new short-lived certificate CA and public key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access policies — cloudflare.zone-level-access-policies-list-access-policies

Lists Access policies configured for an application.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an Access policy — cloudflare.zone-level-access-policies-create-an-access-policy

Create a new Access policy for an application.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.approval_groups — Optional $ref: "#/definitions/access_approval_groups-2"
body.approval_required — Optional $ref: "#/definitions/access_approval_required-2"
body.decision — Required $ref: "#/definitions/access_decision-2"
body.exclude — Optional $ref: "#/definitions/access_exclude-3"
body.include — Required $ref: "#/definitions/access_include"
body.isolation_required — Optional $ref: "#/definitions/access_isolation_required-2"
body.name — Required $ref: "#/definitions/access_name-9"
body.precedence — Optional $ref: "#/definitions/access_precedence-2"
body.purpose_justification_prompt — Optional $ref: "#/definitions/access_purpose_justification_prompt"
body.purpose_justification_required — Optional $ref: "#/definitions/access_purpose_justification_required-2"
body.require — Optional $ref: "#/definitions/access_require-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "decision": "allow",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Access policy — cloudflare.zone-level-access-policies-delete-an-access-policy

Delete an Access policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/access_uuid"
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access policy — cloudflare.zone-level-access-policies-get-an-access-policy

Fetches a single Access policy.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/access_uuid"
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an Access policy — cloudflare.zone-level-access-policies-update-an-access-policy

Update a configured Access policy.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.policy_id — Required $ref: "#/definitions/access_uuid"
path.app_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.approval_groups — Optional $ref: "#/definitions/access_approval_groups-2"
body.approval_required — Optional $ref: "#/definitions/access_approval_required-2"
body.decision — Required $ref: "#/definitions/access_decision-2"
body.exclude — Optional $ref: "#/definitions/access_exclude-3"
body.include — Required $ref: "#/definitions/access_include"
body.isolation_required — Optional $ref: "#/definitions/access_isolation_required-2"
body.name — Required $ref: "#/definitions/access_name-9"
body.precedence — Optional $ref: "#/definitions/access_precedence-2"
body.purpose_justification_prompt — Optional $ref: "#/definitions/access_purpose_justification_prompt"
body.purpose_justification_required — Optional $ref: "#/definitions/access_purpose_justification_required-2"
body.require — Optional $ref: "#/definitions/access_require-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "app_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "decision": "allow",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List mTLS certificates — cloudflare.zone-level-access-mtls-authentication-list-mtls-certificates

Lists all mTLS certificates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-add-an-mtls-certificate

Adds a new mTLS root certificate to Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.associated_hostnames — Optional $ref: "#/definitions/access_associated_hostnames-2"
body.certificate string Required The certificate content.
body.name — Required $ref: "#/definitions/access_name-18"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all mTLS hostname settings — cloudflare.zone-level-access-mtls-authentication-list-mtls-certificat-ae09802d86

List all mTLS hostname settings for this zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an mTLS certificate's hostname settings — cloudflare.zone-level-access-mtls-authentication-update-an-mtls-certi-9ab3745f97

Updates an mTLS certificate's hostname settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.settings array Required
body.settings[] — Optional $ref: "#/definitions/access_settings-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "settings": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-delete-an-mtls-certificate

Deletes an mTLS certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-get-an-mtls-certificate

Fetches a single mTLS certificate.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an mTLS certificate — cloudflare.zone-level-access-mtls-authentication-update-an-mtls-certificate

Updates a configured mTLS certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.associated_hostnames — Required $ref: "#/definitions/access_associated_hostnames-2"
body.name — Optional $ref: "#/definitions/access_name-18"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "associated_hostnames": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access groups — cloudflare.zone-level-access-groups-list-access-groups

Lists all Access groups.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an Access group — cloudflare.zone-level-access-groups-create-an-access-group

Creates a new Access group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.exclude — Optional $ref: "#/definitions/access_exclude"
body.include — Required $ref: "#/definitions/access_include"
body.name — Required $ref: "#/definitions/access_name-16"
body.require — Optional $ref: "#/definitions/access_require"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Access group — cloudflare.zone-level-access-groups-delete-an-access-group

Deletes an Access group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access group — cloudflare.zone-level-access-groups-get-an-access-group

Fetches a single Access group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an Access group — cloudflare.zone-level-access-groups-update-an-access-group

Updates a configured Access group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.exclude — Optional $ref: "#/definitions/access_exclude"
body.include — Required $ref: "#/definitions/access_include"
body.name — Required $ref: "#/definitions/access_name-16"
body.require — Optional $ref: "#/definitions/access_require"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Allow devs",
    "include": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Access identity providers — cloudflare.zone-level-access-identity-providers-list-access-identity-providers

Lists all configured identity providers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an Access identity provider — cloudflare.zone-level-access-identity-providers-add-an-access-identity-provider

Adds a new identity provider to Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_identity-providers-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Widget Corps IDP",
    "type": "onetimepin",
    "config": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an Access identity provider — cloudflare.zone-level-access-identity-providers-delete-an-access-iden-a86f257052

Deletes an identity provider from Access.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Access identity provider — cloudflare.zone-level-access-identity-providers-get-an-access-identity-provider

Fetches a configured identity provider.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an Access identity provider — cloudflare.zone-level-access-identity-providers-update-an-access-iden-dc7a3c4e9e

Updates a configured identity provider.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identity_provider_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"
body — Required $ref: "#/definitions/access_identity-providers-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identity_provider_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "Widget Corps IDP",
    "type": "onetimepin",
    "config": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get your Zero Trust organization — cloudflare.zone-level-zero-trust-organization-get-your-zero-trust-organization

Returns the configuration for your Zero Trust organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier-4"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create your Zero Trust organization — cloudflare.zone-level-zero-trust-organization-create-your-zero-trust--370c6afab3

Sets up a Zero Trust organization for your account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier-4"
body object Required
body.auth_domain — Optional $ref: "#/definitions/access_auth_domain-2"
body.is_ui_read_only — Optional $ref: "#/definitions/access_is_ui_read_only-2"
body.login_design — Optional $ref: "#/definitions/access_login_design"
body.name — Optional $ref: "#/definitions/access_name-15"
body.strict_service_token_auth — Optional $ref: "#/definitions/access_strict_service_token_auth"
body.ui_read_only_toggle_reason — Optional $ref: "#/definitions/access_ui_read_only_toggle_reason"
body.user_seat_expiration_inactive_time — Optional $ref: "#/definitions/access_user_seat_expiration_inactive_time-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update your Zero Trust organization — cloudflare.zone-level-zero-trust-organization-update-your-zero-trust--4e6f7216d2

Updates the configuration for your Zero Trust organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier-4"
body object Required
body.auth_domain — Optional $ref: "#/definitions/access_auth_domain-2"
body.is_ui_read_only — Optional $ref: "#/definitions/access_is_ui_read_only-2"
body.login_design — Optional $ref: "#/definitions/access_login_design"
body.name — Optional $ref: "#/definitions/access_name-15"
body.strict_service_token_auth — Optional $ref: "#/definitions/access_strict_service_token_auth"
body.ui_read_only_toggle_reason — Optional $ref: "#/definitions/access_ui_read_only_toggle_reason"
body.user_seat_expiration_inactive_time — Optional $ref: "#/definitions/access_user_seat_expiration_inactive_time-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke all Access tokens for a user — cloudflare.zone-level-zero-trust-organization-revoke-all-access-token-daef55cb0e

Revokes a user's access across all applications.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier-4"
body object Required
body.email string Required The email of the user to revoke.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List service tokens — cloudflare.zone-level-access-service-tokens-list-service-tokens

Lists all service tokens.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a service token — cloudflare.zone-level-access-service-tokens-create-a-service-token

Generates a new service token. Note: This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.client_secret_version — Optional $ref: "#/definitions/access_client_secret_version"
body.duration — Optional $ref: "#/definitions/access_duration-2"
body.enabled — Optional $ref: "#/definitions/access_enabled"
body.name — Required $ref: "#/definitions/access_name-17"
body.previous_client_secret_expires_at — Optional $ref: "#/definitions/access_previous_client_secret_expires_at"
body.tags — Optional $ref: "#/definitions/access_tags"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "CI/CD token"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a service token — cloudflare.zone-level-access-service-tokens-delete-a-service-token

Deletes a service token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a service token — cloudflare.zone-level-access-service-tokens-get-a-service-token

Fetches a single service token.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a service token — cloudflare.zone-level-access-service-tokens-update-a-service-token

Updates a configured service token.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.service_token_id — Required $ref: "#/definitions/access_uuid"
path.zone_id — Required $ref: "#/definitions/access_identifier"
body object Required
body.client_secret_version — Optional $ref: "#/definitions/access_client_secret_version"
body.duration — Optional $ref: "#/definitions/access_duration-2"
body.enabled — Optional $ref: "#/definitions/access_enabled"
body.name — Optional $ref: "#/definitions/access_name-17"
body.previous_client_secret_expires_at — Optional $ref: "#/definitions/access_previous_client_secret_expires_at"
body.tags — Optional $ref: "#/definitions/access_tags"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "service_token_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Custom Origin Trust Store Details — cloudflare.custom-origin-trust-store-list-details

Get Custom Origin Trust Store for a Zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of records per page. default: 20; minimum: 5; maximum: 50
query.limit integer Optional Limit to the number of records returned.
query.offset integer Optional Offset the results.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload Custom Origin Trust Store — cloudflare.custom-origin-trust-store-create

Upload a root CA certificate to the Custom Origin Trust Store for a Zone. Only root CA certificates are accepted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.certificate — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Custom Origin Trust Store — cloudflare.custom-origin-trust-store-delete

Removes a root CA certificate from the custom origin trust store. Origins using certificates signed by this CA will no longer be trusted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_origin_trust_store_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_trust_store_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_origin_trust_store_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Custom Origin Trust Store Details — cloudflare.custom-origin-trust-store-details

Retrieves details about a specific root CA certificate in the custom origin trust store, including expiration and subject information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_origin_trust_store_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_trust_store_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_origin_trust_store_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Total TLS Settings Details — cloudflare.total-tls-total-tls-settings-details

Get Total TLS Settings for a Zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable or Disable Total TLS — cloudflare.total-tls-enable-or-disable-total-tls

Set Total TLS Settings or disable the feature for a Zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.certificate_authority — Optional $ref: "#/definitions/tls-certificates-and-hostnames_certificate_authority-3"
body.enabled — Required $ref: "#/definitions/tls-certificates-and-hostnames_enabled-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rerun the Activation Check — cloudflare.put-zones-zone_id-activation_check

Triggeres a new activation check for a PENDING Zone. This can be triggered every 5 min for paygo/ent customers, every hour for FREE Zones.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone ID $ref: "#/definitions/zone-activation_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Regional Hostnames — cloudflare.dls-zone-regional-hostnames-list

List all Regional Hostnames within a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dls_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Regional Hostname — cloudflare.dls-zone-regional-hostnames-create

Create a new Regional Hostname entry. Cloudflare will only use data centers that are physically located within the chosen region to decrypt and service HTTPS traffic. Learn more about Regional Services.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dls_identifier"
body object Optional
body.hostname — Required $ref: "#/definitions/dls_hostname"
body.region_key — Required $ref: "#/definitions/dls_region_key"
body.routing — Optional $ref: "#/definitions/dls_routing"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Regional Hostname — cloudflare.dls-zone-regional-hostnames-delete

Delete the region configuration for a specific Regional Hostname.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dls_identifier"
path.hostname — Required $ref: "#/definitions/dls_hostname"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hostname": "foo.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fetch Regional Hostname — cloudflare.dls-zone-regional-hostnames-fetch

Fetch the configuration for a specific Regional Hostname, within a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dls_identifier"
path.hostname — Required $ref: "#/definitions/dls_hostname"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hostname": "foo.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Regional Hostname — cloudflare.dls-zone-regional-hostnames-patch

Update the configuration for a specific Regional Hostname. Only the region_key of a hostname is mutable.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dls_identifier"
path.hostname — Required $ref: "#/definitions/dls_hostname"
body object Optional
body.region_key — Required $ref: "#/definitions/dls_region_key"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "hostname": "foo.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get robots.txt rules — cloudflare.ai-audit-get-robots

Fetches and parses the robots.txt file for a zone or a specific subdomain within the zone. Returns parsed user-agent rules, content signals, and sitemaps.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.
query object Optional additionalProperties: false
query.subdomain string Optional Optional subdomain to fetch robots.txt for. If omitted, fetches robots.txt for the zone apex domain.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk get robots.txt rules — cloudflare.ai-audit-bulk-get-robots

Fetches and parses robots.txt files for multiple domains within a zone in a single request. Each domain must belong to the specified zone. Results are keyed by hostname.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.
body array Required Array of domain hostnames to fetch robots.txt for. Each domain must end with the zone name. Maximum 25 domains per request. maxItems: 25
body[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": [
    "example.com",
    "blog.example.com"
  ]
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the AI Security for Apps custom topics of a zone. — cloudflare.ai-security-custom-topics-get

Get the custom topic categories defined for the zone. While AI Security for Apps is enabled, it scores every incoming prompt against these topics and writes the scores to the cf.llm.prompt.custom_topic_categories field, keyed by topic label. Topics can be configured while the detection is disabled, but no prompt is scored until you enable it.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_zone_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the AI Security for Apps custom topics of a zone. — cloudflare.ai-security-custom-topics-put

Update the custom topic list of the zone, overwriting it entirely with the topics in the request, so include every topic you want to keep. Changes can take up to a minute to propagate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_zone_id"
body — Required $ref: "#/definitions/waf-product-api-bundle_custom-topics"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the AI Security for Apps status for a zone. — cloudflare.ai-security-settings-get

Get the current AI Security for Apps status for the zone. While enabled, Cloudflare scans prompts sent to endpoints labeled cf-llm for personally identifiable information, unsafe topics, and prompt injection attempts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_zone_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the AI Security for Apps status for a zone. — cloudflare.ai-security-settings-put

Update the AI Security for Apps status for the zone, enabling or disabling the detection. The detection results are exposed as cf.llm.prompt. fields for use in custom rules and rate limiting rules; changes can take up to a minute to propagate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_zone_id"
body — Required $ref: "#/definitions/waf-product-api-bundle_settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Argo Analytics for a zone — cloudflare.argo-analytics-for-zone-argo-analytics-for-a-zone

Retrieves aggregate Argo Smart Routing analytics for a zone, including latency improvements, bandwidth savings, and routing statistics.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/argo-analytics_identifier"
query object Optional additionalProperties: false
query.bins string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Argo Analytics for a zone at different PoPs — cloudflare.argo-analytics-for-geolocation-argo-analytics-for-a-zone-a-1002d24562

Retrieves Argo Smart Routing analytics broken down by geographic points of presence (PoPs). Shows latency improvements and routing efficiency per location.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/argo-analytics_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get session identifier settings — cloudflare.api-shield-settings-retrieve-information-about-specific-co-4672584b9d

Returns the authentication identifier characteristics configured for the zone. Header, cookie, or JWT claim values identify distinct API sessions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.normalize boolean Optional Ensures that the configuration is written or retrieved in normalized fashion

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update session identifier settings — cloudflare.api-shield-settings-set-configuration-properties

Replaces the zone's authentication identifier characteristics used to identify distinct API sessions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.normalize boolean Optional Ensures that the configuration is written or retrieved in normalized fashion
body — Required $ref: "#/definitions/api-shield_configuration"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "auth_id_characteristics": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export discovered API operations as OpenAPI schemas — cloudflare.api-shield-api-discovery-retrieve-discovered-operations-on-da306fd4a9

Returns the latest API operations discovered from zone traffic, rendered as OpenAPI schemas.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List discovered web and API operations — cloudflare.api-shield-api-discovery-retrieve-discovered-operations-on-a-zone

Returns the latest web and API operations discovered from zone traffic.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.host array Optional Filter results to only include the specified hosts. uniqueItems: true
query.host[] string Optional
query.method array Optional Filter results to only include the specified HTTP methods. uniqueItems: true
query.method[] string Optional
query.endpoint string Optional Filter results to only include endpoints containing this pattern.
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.order string Optional Field to order by enum: ["host","method","endpoint","traffic_stats.requests","traffic_stats.last_updated"]
query.diff boolean Optional When true, only return API Discovery results that are not saved into API Shield Endpoint Management
query.origin — Optional Filter results to only include discovery results sourced from a particular discovery engine * ML - Discovered operations that were sourced using ML API Discovery * SessionIdentifier - Discovered operations that were sourced using Session Identifier API Discovery $ref: "#/definitions/api-shield_api_discovery_origin"
query.state — Optional Filter results to only include discovery results in a particular state. States are as follows * review - Discovered operations that are not saved into API Shield Endpoint Management * saved - Discovered operations that are already saved into API Shield Endpoint Management * ignored - Discovered operations that have been marked as ignored $ref: "#/definitions/api-shield_api_discovery_state"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit discovered web and API operations — cloudflare.api-shield-api-patch-discovered-operations

Updates the state of one or more discovered web and API operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body — Required $ref: "#/definitions/api-shield_api_discovery_patch_multiple_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "3818d821-5901-4147-a474-f5f5aec1d54e": {
      "state": "ignored"
    },
    "b17c8043-99a0-4202-b7d9-8f7cdbee02cd": {
      "state": "review"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a discovered web or API operation — cloudflare.api-shield-api-discovery-retrieve-discovered-operation-by-id

Returns a discovered web or API operation by discovery ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.discovery_id — Required Discovery ID of a discovered operation $ref: "#/definitions/api-shield_uuid-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "discovery_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a discovered web or API operation — cloudflare.api-shield-api-patch-discovered-operation

Updates the state of a discovered web or API operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.discovery_id — Required Discovery ID of a discovered operation $ref: "#/definitions/api-shield_uuid-2"
body object Required
body.state — Optional
body.state — Optional allOf[1]; $ref: "#/definitions/api-shield_api_discovery_state_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "discovery_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List operation labels — cloudflare.api-shield-labels-get-labels

Returns all managed and user-defined labels available for web and API operations in the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.order string Optional Field to order by enum: ["name","description","created_at","last_updated","mapped_resources.operations"]
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.source — Optional Filter for labels with source $ref: "#/definitions/api-shield_label_source"
query.filter string Optional Filter for labels where the name or description matches using substring match
query.with_mapped_resource_counts boolean Optional Include mapped_resources for each label default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a managed operation label — cloudflare.api-shield-labels-get-managed-label

Returns a managed label and the web and API operations associated with it.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.name — Required The label name $ref: "#/definitions/api-shield_label_name"
query object Optional additionalProperties: false
query.with_mapped_resource_counts boolean Optional Include mapped_resources for each label default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "login"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace operations attached to a managed label — cloudflare.api-shield-labels-replace-operations-attached-to-managed-label

Replaces the complete set of web and API operations attached to the managed label.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.name — Required The label name $ref: "#/definitions/api-shield_label_name"
body — Required $ref: "#/definitions/api-shield_replace_operations_attached_to_label_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "login"
  },
  "body": {
    "selector": {
      "include": {
        "operation_ids": [
          "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        ]
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete user-defined operation labels — cloudflare.api-shield-labels-delete-user-labels

Deletes one or more user-defined labels and removes their associations with web and API operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body array Required
body[] — Optional $ref: "#/definitions/api-shield_label_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create user-defined operation labels — cloudflare.api-shield-labels-create-user-labels

Creates one or more user-defined labels for classifying web and API operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body array Required
body[] — Optional $ref: "#/definitions/api-shield_label_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a user-defined operation label — cloudflare.api-shield-delete-user-label

Deletes a user-defined label and removes its associations with web and API operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.name — Required The label name $ref: "#/definitions/api-shield_label_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "login"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user-defined operation label — cloudflare.api-shield-labels-get-user-label

Returns a user-defined label and the web and API operations associated with it.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.name — Required The label name $ref: "#/definitions/api-shield_label_name"
query object Optional additionalProperties: false
query.with_mapped_resource_counts boolean Optional Include mapped_resources for each label default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "login"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a user-defined operation label — cloudflare.api-shield-patch-user-label

Updates only the supplied fields on a user-defined label.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.name — Required The label name $ref: "#/definitions/api-shield_label_name"
body — Required $ref: "#/definitions/api-shield_patch_label_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "login"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a user-defined operation label — cloudflare.api-shield-put-user-label

Replaces all editable fields on a user-defined label.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.name — Required The label name $ref: "#/definitions/api-shield_label_name"
body — Required $ref: "#/definitions/api-shield_put_label_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "login"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace operations attached to a user-defined label — cloudflare.api-shield-labels-replace-operations-attached-to-user-label

Replaces the complete set of web and API operations attached to the user-defined label.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.name — Required The label name $ref: "#/definitions/api-shield_label_name"
body — Required $ref: "#/definitions/api-shield_replace_operations_attached_to_label_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "login"
  },
  "body": {
    "selector": {
      "include": {
        "operation_ids": [
          "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        ]
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete web or API operations — cloudflare.api-shield-endpoint-management-delete-multiple-operations

Deletes multiple web or API operations from endpoint management in one request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body array Required uniqueItems: true
body[] — Optional $ref: "#/definitions/api-shield_object-with-operation-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": [
    {
      "operation_id": "b17c8043-99a0-4202-b7d9-8f7cdbee02cd"
    },
    {
      "operation_id": "3818d821-5901-4147-a474-f5f5aec1d54e"
    }
  ]
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List web and API operations — cloudflare.api-shield-endpoint-management-retrieve-information-about--6722bf7447

Lists web and API operations tracked for the zone, including each operation's method, path, and feature configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.order string Optional Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. enum: ["method","host","endpoint","thresholds.$key"]
query.direction string Optional Direction to order results. enum: ["asc","desc"]
query.host array Optional Filter results to only include the specified hosts. uniqueItems: true
query.host[] string Optional
query.method array Optional Filter results to only include the specified HTTP methods. uniqueItems: true
query.method[] string Optional
query.endpoint string Optional Filter results to only include endpoints containing this pattern.
query.feature array Optional Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. uniqueItems: true
query.feature[] string Optional enum: ["thresholds","parameter_schemas","schema_info","confidence_intervals"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create web or API operations — cloudflare.api-shield-endpoint-management-add-operations-to-a-zone

Creates one or more web or API operations. Hosts, methods, and paths are normalized; an existing matching operation is returned instead of duplicated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body array Required
body[] — Optional $ref: "#/definitions/api-shield_basic_operation"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a web or API operation — cloudflare.api-shield-endpoint-management-add-operation-to-a-zone

Creates one web or API operation. The host, method, and path are normalized; an existing matching operation is returned instead of duplicated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body — Required $ref: "#/definitions/api-shield_basic_operation"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "method": "GET",
    "host": "www.example.com",
    "endpoint": "/api/v1/users/{var1}"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove labels from web or API operations — cloudflare.api-shield-operations-bulk-delete-labels-to-operations

Removes labels from multiple web or API operations in one request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body — Required $ref: "#/definitions/api-shield_bulk_delete_labels_on_operation_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "selector": {
      "include": {
        "operation_ids": [
          "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        ]
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Attach labels to web or API operations — cloudflare.api-shield-operations-bulk-post-labels-to-operations

Attaches labels to multiple web or API operations in one request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body — Required $ref: "#/definitions/api-shield_bulk_post_labels_on_operation_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "selector": {
      "include": {
        "operation_ids": [
          "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        ]
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace labels on web or API operations — cloudflare.api-shield-operations-bulk-put-labels-to-operations

Replaces the complete label sets on multiple web or API operations in one request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body — Required $ref: "#/definitions/api-shield_bulk_put_labels_on_operation_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "selector": {
      "include": {
        "operation_ids": [
          "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        ]
      }
    },
    "user": {
      "labels": []
    },
    "managed": {
      "labels": []
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a web or API operation — cloudflare.api-shield-endpoint-management-delete-an-operation

Deletes a web or API operation from endpoint management so its feature configuration is no longer tracked.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.operation_id — Required Identifier for the operation $ref: "#/definitions/api-shield_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a web or API operation — cloudflare.api-shield-endpoint-management-retrieve-information-about--43cd9e45f3

Returns a web or API operation, including its schema validation settings and requested feature data.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.operation_id — Required Identifier for the operation $ref: "#/definitions/api-shield_uuid"
query object Optional additionalProperties: false
query.feature array Optional Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. uniqueItems: true
query.feature[] string Optional enum: ["thresholds","parameter_schemas","schema_info","confidence_intervals"]
query.with_schemas boolean Optional When true, includes OpenAPI schemas (both uploaded and learned) for the operation in the response. Due to the conversion overhead, this parameter is only supported on single-operation retrieval. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove labels from a web or API operation — cloudflare.api-shield-operations-delete-labels-from-operation

Removes one or more labels from a web or API operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.operation_id — Required Identifier for the operation $ref: "#/definitions/api-shield_uuid"
body — Required $ref: "#/definitions/api-shield_delete_labels_on_operation_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Attach labels to a web or API operation — cloudflare.api-shield-operations-post-labels-to-operation

Attaches one or more labels to a web or API operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.operation_id — Required Identifier for the operation $ref: "#/definitions/api-shield_uuid"
body — Required $ref: "#/definitions/api-shield_post_labels_on_operation_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace labels on a web or API operation — cloudflare.api-shield-operations-put-labels-to-operation

Replaces the complete label set on a web or API operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.operation_id — Required Identifier for the operation $ref: "#/definitions/api-shield_uuid"
body — Required $ref: "#/definitions/api-shield_put_labels_on_operation_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export web and API operations as OpenAPI schemas — cloudflare.api-shield-endpoint-management-retrieve-operations-and-fea-7969eb7eff

Returns tracked web and API operations and their feature configuration rendered as OpenAPI schemas.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.host array Optional Receive schema only for the given host(s). uniqueItems: true
query.host[] string Optional
query.feature array Optional Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. uniqueItems: true
query.feature[] string Optional enum: ["thresholds","parameter_schemas","schema_info","confidence_intervals"]
query.include_schema_kind array Optional Schema kinds to include in exported OpenAPI schemas. uniqueItems: true
query.include_schema_kind[] string Optional enum: ["learned"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Argo Smart Routing setting — cloudflare.argo-smart-routing-get-argo-smart-routing-setting

Retrieves the value of Argo Smart Routing enablement setting.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/argo-config_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Argo Smart Routing setting — cloudflare.argo-smart-routing-patch-argo-smart-routing-setting

Configures the value of the Argo Smart Routing enablement setting.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/argo-config_identifier"
body — Required $ref: "#/definitions/argo-config_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "on"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Tiered Cache — cloudflare.tiered-caching-get-tiered-caching-setting

Retrieves whether Tiered Cache is enabled for a zone. Tiered Cache reduces origin traffic by serving lower-tier cache misses from upper-tier data centers before requesting content from your origin.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Tiered Cache — cloudflare.tiered-caching-patch-tiered-caching-setting

Enables or disables Tiered Cache for a zone. Tiered Cache reduces origin traffic by serving lower-tier cache misses from upper-tier data centers before requesting content from your origin.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body — Required $ref: "#/definitions/cache-settings_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "on"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Available Plans — cloudflare.zone-rate-plan-list-available-plans

Lists available plans the zone can subscribe to.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Available Plan Details — cloudflare.zone-rate-plan-available-plan-details

Details of the available plan that the zone can subscribe to.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.plan_identifier — Required $ref: "#/definitions/bill-subs-api_identifier"
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "plan_identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Available Rate Plans — cloudflare.zone-rate-plan-list-available-rate-plans

Lists all rate plans the zone can subscribe to.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zone Bot Management Config — cloudflare.bot-management-for-a-zone-get-config

Retrieve a zone's Bot Management Config

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bot-management_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List zone feedback reports — cloudflare.bot-management-zone-feedback-list

Returns all feedback reports previously submitted for the specified zone. Feedback reports help improve detection by sharing samples of traffic that were misclassified as bots or humans.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bot-management_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Submit a feedback report — cloudflare.bot-management-zone-feedback-create

Submit a feedback report for the specified zone. Use type to indicate whether the report is a false positive (good traffic flagged as bot) or a false negative (bot traffic missed). Furthermore, you can also use expression as a wirefilter to identify the affected traffic sample.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bot-management_identifier"
body — Required $ref: "#/definitions/bot-management_feedback_report"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "false_positive",
    "description": "example",
    "expression": "example",
    "first_request_seen_at": "2026-01-01T00:00:00Z",
    "last_request_seen_at": "2026-01-01T00:00:00Z",
    "requests": 1,
    "requests_by_score": {},
    "requests_by_score_src": {},
    "requests_by_attribute": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cache Reserve setting — cloudflare.zone-cache-settings-get-cache-reserve-setting

Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the developer docs for more information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Cache Reserve setting — cloudflare.zone-cache-settings-change-cache-reserve-setting

Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the developer docs for more information.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_cache_reserve_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cache Reserve Clear — cloudflare.zone-cache-settings-get-cache-reserve-clear

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start Cache Reserve Clear — cloudflare.zone-cache-settings-start-cache-reserve-clear

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Regional Tiered Cache setting — cloudflare.zone-cache-settings-get-regional-tiered-cache-setting

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Regional Tiered Cache setting — cloudflare.zone-cache-settings-change-regional-tiered-cache-setting

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_regional_tiered_cache_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Smart Tiered Cache setting — cloudflare.smart-tiered-cache-delete-smart-tiered-cache-setting

Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Smart Tiered Cache setting — cloudflare.smart-tiered-cache-get-smart-tiered-cache-setting

Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Smart Tiered Cache setting — cloudflare.smart-tiered-cache-patch-smart-tiered-cache-setting

Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body — Required $ref: "#/definitions/cache-settings_smart_tiered_cache_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "on"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Smart Tiered Cache setting — cloudflare.smart-tiered-cache-create-smart-tiered-cache-setting

Smart Tiered Cache dynamically selects the single closest upper tier for each of your website's origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body — Required $ref: "#/definitions/cache-settings_smart_tiered_cache_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "on"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete variants setting — cloudflare.zone-cache-settings-delete-variants-setting

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get variants setting — cloudflare.zone-cache-settings-get-variants-setting

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change variants setting — cloudflare.zone-cache-settings-change-variants-setting

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_variants_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Hostname Associations — cloudflare.client-certificate-for-a-zone-list-hostname-associations

List Hostname Associations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.mtls_certificate_id string Optional The UUID to match against for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the results will be the hostnames associated to your active Cloudflare Managed CA. minLength: 36; maxLength: 36

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Hostname Associations — cloudflare.client-certificate-for-a-zone-put-hostname-associations

Replace Hostname Associations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname_association"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Client Certificates — cloudflare.client-certificate-for-a-zone-list-client-certificates

List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.status string Optional Client Certitifcate Status to filter results by. enum: ["all","active","pending_reactivation","pending_revocation","revoked"]
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of records per page. default: 20; minimum: 5; maximum: 50
query.limit integer Optional Limit to the number of records returned.
query.offset integer Optional Offset the results.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Client Certificate — cloudflare.client-certificate-for-a-zone-create-client-certificate

Create a new API Shield mTLS Client Certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.csr — Required $ref: "#/definitions/tls-certificates-and-hostnames_csr-2"
body.validity_days — Required $ref: "#/definitions/tls-certificates-and-hostnames_validity_days-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICY....\n-----END CERTIFICATE REQUEST-----",
    "validity_days": 3650
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Revoke Client Certificate — cloudflare.client-certificate-for-a-zone-delete-client-certificate

Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
path.client_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_client_certificate_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "client_certificate_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Client Certificate Details — cloudflare.client-certificate-for-a-zone-client-certificate-details

Get Details for a single mTLS API Shield Client Certificate.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
path.client_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_client_certificate_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "client_certificate_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reactivate Client Certificate — cloudflare.client-certificate-for-a-zone-edit-client-certificate

If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
path.client_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_client_certificate_identifier"
body object Required
body.reactivate boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "client_certificate_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rules — cloudflare.zone-cloud-connector-rules

Retrieves the Cloud Connector rules configured for a zone. Rules define how traffic is routed to cloud services.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cloud-connector_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Put Rules — cloudflare.zone-cloud-conenctor-rules-put

Updates Cloud Connector rules for a zone, replacing the existing rule configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cloud-connector_identifier"
body array Required
body[] — Optional $ref: "#/definitions/cloud-connector_rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable Content Scanning for a zone. — cloudflare.waf-content-scanning-disable

Disable Content Scanning for a zone. The cf.waf.content_scan. fields are no longer populated, so rules that reference them stop matching.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable Content Scanning for a zone. — cloudflare.waf-content-scanning-enable

Enable Content Scanning for a zone, so that Cloudflare inspects content objects uploaded to the zone and checks them for malware. Scan results populate the cf.waf.content_scan. fields, which you can reference in custom rules and rate limiting rules.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List the Content Scanning custom expressions of a zone. — cloudflare.waf-content-scanning-list-custom-scan-expressions

List the Content Scanning custom expressions configured for the zone, each with its own identifier. A custom expression tells the scanner how to reach content objects in a request it cannot parse on its own, such as files Base64-encoded inside a JSON body.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Content Scanning custom expressions for a zone. — cloudflare.waf-content-scanning-add-custom-scan-expressions

Create one or more Content Scanning custom expressions, appending them to the existing list of the zone, and return the updated list. Each expression reaches content objects the scanner cannot find automatically, for example lookup_json_string(http.request.body.raw, "file").

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
body array Required
body[] object Optional
body[].payload — Required $ref: "#/definitions/waf-product-api-bundle_custom-scan-payload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Content Scanning custom expression from a zone. — cloudflare.waf-content-scanning-delete-custom-scan-expressions

Delete the Content Scanning custom expression with the given identifier and return the expressions that remain. Content objects reached only by the deleted expression are no longer scanned.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
path.expression_id — Required $ref: "#/definitions/waf-product-api-bundle_custom-scan-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "expression_id": "a350a054caa840c9becd89c3b4f0195b"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Content Scanning custom expression for a zone. — cloudflare.waf-content-scanning-update-custom-scan-expression

Update the Content Scanning custom expression with the given identifier and return the updated list of expressions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
path.expression_id — Required $ref: "#/definitions/waf-product-api-bundle_custom-scan-id"
body object Required
body.payload — Required $ref: "#/definitions/waf-product-api-bundle_custom-scan-payload"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "expression_id": "a350a054caa840c9becd89c3b4f0195b"
  },
  "body": {
    "payload": "lookup_json_string(http.request.body.raw, \"file\")"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Content Scanning status for a zone. — cloudflare.waf-content-scanning-get-status

Get the current Content Scanning status for the zone, together with the date the status was last modified.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the Content Scanning status for a zone. — cloudflare.waf-content-scanning-update-settings

Update the Content Scanning status by setting the status value to enabled or disabled. This is equivalent to calling the dedicated enable and disable endpoints.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
body object Required
body.value string Required The status value for Content Scanning. enum: ["enabled","disabled"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "enabled"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get CT Alerting Subscription — cloudflare.ct-alerting-get-subscription

Retrieve the Certificate Transparency alerting subscription settings for a zone. Returns whether CT monitoring is enabled and the list of email addresses that receive alerts, if any have been configured.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update CT Alerting Subscription — cloudflare.ct-alerting-update-subscription

Create or update the Certificate Transparency alerting subscription for a zone. Enables or disables email notifications when certificates are issued for the zone's domains. The enabled field is required on every request and controls whether the subscription is active. The emails field is optional and, when provided, replaces the stored recipient list for the zone. When emails is omitted, the stored recipient list is preserved and only the enabled state is toggled. A maximum of 100 email addresses may be configured per zone. Requests that omit enabled are rejected with error code 1008. Subscribe and unsubscribe notification emails are only sent for recipients whose effective subscription state changes. Idempotent requests (no state change) send no notification email.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body — Required $ref: "#/definitions/tls-certificates-and-hostnames_ct_alerting_subscription_update"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SSL Configurations — cloudflare.custom-ssl-for-a-zone-list-ssl-configurations

List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of zones per page. default: 20; minimum: 5; maximum: 50
query.match string Optional Whether to match all search requirements or at least one (any). enum: ["any","all"]; default: "all"
query.status string Optional Status of the zone's custom SSL. enum: ["active","expired","deleted","pending","initializing"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create SSL Configuration — cloudflare.custom-ssl-for-a-zone-create-ssl-configuration

Upload a new SSL certificate for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.bundle_method — Optional $ref: "#/definitions/tls-certificates-and-hostnames_bundle_method"
body.certificate — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate"
body.custom_csr_id — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_id"
body.deploy — Optional $ref: "#/definitions/tls-certificates-and-hostnames_deploy"
body.geo_restrictions — Optional $ref: "#/definitions/tls-certificates-and-hostnames_geo_restrictions"
body.policy — Optional $ref: "#/definitions/tls-certificates-and-hostnames_policy"
body.private_key — Optional $ref: "#/definitions/tls-certificates-and-hostnames_private_key"
body.type — Optional $ref: "#/definitions/tls-certificates-and-hostnames_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Re-prioritize SSL Certificates — cloudflare.custom-ssl-for-a-zone-re-prioritize-ssl-certificates

If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.certificates array Required Array of ordered certificates.
body.certificates[] object Optional
body.certificates[].id — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_certificate_identifier"
body.certificates[].priority — Optional $ref: "#/definitions/tls-certificates-and-hostnames_priority"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "certificates": [
      {
        "id": "5a7805061c76ada191ed06f989cc3dac",
        "priority": 2
      },
      {
        "id": "9a7806061c88ada191ed06f989cc3dac",
        "priority": 1
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete SSL Configuration — cloudflare.custom-ssl-for-a-zone-delete-ssl-configuration

Remove a SSL certificate from a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

SSL Configuration Details — cloudflare.custom-ssl-for-a-zone-ssl-configuration-details

Retrieves details for a specific custom SSL certificate, including certificate metadata, bundle method, geographic restrictions, and associated keyless server configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit SSL Configuration — cloudflare.custom-ssl-for-a-zone-edit-ssl-configuration

Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.bundle_method — Optional $ref: "#/definitions/tls-certificates-and-hostnames_bundle_method"
body.certificate — Optional $ref: "#/definitions/tls-certificates-and-hostnames_certificate"
body.custom_csr_id — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_id"
body.deploy — Optional $ref: "#/definitions/tls-certificates-and-hostnames_deploy"
body.geo_restrictions — Optional $ref: "#/definitions/tls-certificates-and-hostnames_geo_restrictions"
body.policy — Optional $ref: "#/definitions/tls-certificates-and-hostnames_policy"
body.private_key — Optional $ref: "#/definitions/tls-certificates-and-hostnames_private_key"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Custom CSRs — cloudflare.custom-csrs-for-a-zone-list-custom-csrs

List all custom Certificate Signing Requests (CSRs) for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of custom CSRs per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Custom CSR — cloudflare.custom-csrs-for-a-zone-create-custom-csr

Generate a new custom Certificate Signing Request (CSR) for a zone. Cloudflare generates and securely stores the private key associated with the CSR. The CSR can then be provided to a Certificate Authority for signing. Once signed, the certificate is uploaded via the Custom SSL endpoint using the CSR ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "country": "US",
    "state": "California",
    "locality": "San Francisco",
    "organization": "Cloudflare, Inc.",
    "common_name": "example.com",
    "sans": [
      "example.com",
      "www.example.com"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Custom CSR — cloudflare.custom-csrs-for-a-zone-delete-custom-csr

Delete a custom Certificate Signing Request (CSR) and its associated private key. A CSR cannot be deleted if any custom certificates still reference it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_csr_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Custom CSR Details — cloudflare.custom-csrs-for-a-zone-custom-csr-details

Retrieve details for a specific custom Certificate Signing Request (CSR).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_csr_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_csr_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Custom Hostnames — cloudflare.custom-hostname-for-a-zone-list-custom-hostnames

List, search, sort, and filter all of your custom hostnames.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.hostname string Optional Fully qualified domain name to match against. This parameter cannot be used with the 'id', 'hostname.exact', 'hostname.contain', or 'hostname.startsWith' parameters. maxLength: 255
query.hostname.exact string Optional Fully qualified domain name to match against. This parameter cannot be used with the 'id', 'hostname', 'hostname.contain', or 'hostname.startsWith' parameters. maxLength: 255
query.hostname.startsWith string Optional Filters hostnames by a prefix match on the hostname value. This parameter cannot be used with the 'id', 'hostname', 'hostname.exact', or 'hostname.contain' parameters. maxLength: 255
query.hostname.contain string Optional Filters hostnames by a substring match on the hostname value. This parameter cannot be used with the 'id', 'hostname', 'hostname.exact', or 'hostname.startsWith' parameters. maxLength: 255
query.id string Optional Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname', 'hostname.exact', 'hostname.contain', or 'hostname.startsWith' parameters. minLength: 36; maxLength: 36
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of hostnames per page. default: 20; minimum: 5; maximum: 1000
query.order string Optional Field to order hostnames by. enum: ["ssl","ssl_status"]; default: "ssl"
query.direction string Optional Direction to order hostnames. enum: ["asc","desc"]
query.ssl_status string Optional Filter by SSL certificate status. enum: ["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"]
query.hostname_status string Optional Filter by the hostname's activation status. enum: ["active","pending","active_redeploying","moved","pending_deletion","deleted","pending_blocked","pending_migration","pending_provisioned","test_pending","test_active","test_active_apex","test_blocked","test_failed","provisioned","blocked"]
query.certificate_authority string Optional Filter by the certificate authority that issued the SSL certificate. enum: ["google","lets_encrypt","ssl_com"]
query.wildcard boolean Optional Filter by whether the custom hostname is a wildcard hostname.
query.custom_origin_server string Optional Filter by custom origin server name.
query.ssl integer Optional Whether to filter hostnames based on if they have SSL enabled. enum: [0,1]; default: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Custom Hostname — cloudflare.custom-hostname-for-a-zone-create-custom-hostname

Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation). Enable bundling of certificates using the custom_cert_bundle field. The bundling process requires the following condition One certificate in the bundle must use an RSA, and the other must use an ECDSA.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.custom_metadata — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_metadata"
body.custom_origin_server — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_origin_server"
body.custom_origin_sni — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_origin_sni"
body.hostname — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname_post"
body.ssl — Optional $ref: "#/definitions/tls-certificates-and-hostnames_sslpost"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "hostname": "app.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Fallback Origin for Custom Hostnames — cloudflare.custom-hostname-fallback-origin-for-a-zone-delete-fallback-a74258cd43

Removes the fallback origin configuration for custom hostnames on a zone. Custom hostnames without specific origins will no longer have a fallback.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Fallback Origin for Custom Hostnames — cloudflare.custom-hostname-fallback-origin-for-a-zone-get-fallback-or-c9aa7aaff5

Retrieves the current fallback origin configuration for custom hostnames on a zone. The fallback origin handles traffic when specific custom hostname origins are unavailable.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Fallback Origin for Custom Hostnames — cloudflare.custom-hostname-fallback-origin-for-a-zone-update-fallback-3465fb829a

Updates the fallback origin configuration for custom hostnames on a zone. Sets the default origin server for custom hostname traffic.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.origin — Required $ref: "#/definitions/tls-certificates-and-hostnames_origin"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "origin": "fallback.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Custom Hostname Quota — cloudflare.custom-hostname-for-a-zone-get-custom-hostname-quota

Returns custom hostname quota usage for a zone. The allocated quota is a soft limit; creating custom hostnames after usage exceeds this limit can still succeed until the hard cap is reached. Use the exceeded and hard_cap fields to track when usage is above the soft limit and when new custom hostname creation will be rejected.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Custom Hostname (and any issued SSL certificates) — cloudflare.custom-hostname-for-a-zone-delete-custom-hostname---and-an-be27c53402

Permanently deletes a custom hostname and revokes any SSL certificates that were issued for it. This action cannot be undone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_hostname_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_hostname_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Custom Hostname Details — cloudflare.custom-hostname-for-a-zone-custom-hostname-details

Retrieves detailed information about a specific custom hostname, including SSL certificate status, ownership verification, and origin configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_hostname_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_hostname_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Custom Hostname — cloudflare.custom-hostname-for-a-zone-edit-custom-hostname

Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'. Bundle an existing certificate with another certificate by using the "custom_cert_bundle" field. The bundling process supports combining certificates as long as the following condition is met. One certificate must use the RSA algorithm, and the other must use the ECDSA algorithm.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_hostname_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.custom_metadata — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_metadata"
body.custom_origin_server — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_origin_server"
body.custom_origin_sni — Optional $ref: "#/definitions/tls-certificates-and-hostnames_custom_origin_sni"
body.ssl — Optional $ref: "#/definitions/tls-certificates-and-hostnames_sslpost"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_hostname_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Single Certificate And Key For Custom Hostname — cloudflare.custom-hostname-for-a-zone-delete_single_certificate_and_k-57ef29945b

Delete a single custom certificate from a certificate pack that contains two bundled certificates. Deletion is subject to the following constraints. You cannot delete a certificate if it is the only remaining certificate in the pack. At least one certificate must remain in the pack.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_hostname_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.certificate_pack_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_hostname_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "certificate_pack_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "certificate_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Custom Certificate and Custom Key In Custom Hostname — cloudflare.custom-hostname-for-a-zone-edit-custom-certificate-custom-hostname

Replace a single custom certificate within a certificate pack that contains two bundled certificates. The replacement must adhere to the following constraints. You can only replace an RSA certificate with another RSA certificate or an ECDSA certificate with another ECDSA certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_hostname_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.certificate_pack_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_hostname_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body — Required $ref: "#/definitions/tls-certificates-and-hostnames_custom_cert_and_key"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_hostname_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "certificate_pack_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "certificate_id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "custom_certificate": "-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n",
    "custom_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5...\n-----END PRIVATE KEY-----\n"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom pages — cloudflare.custom-pages-for-a-zone-list-custom-pages

Lists all custom page configurations for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List custom assets — cloudflare.custom-assets-for-a-zone-list-custom-assets

Lists custom assets for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of custom assets per page. default: 20; minimum: 1; maximum: 200

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom asset — cloudflare.custom-assets-for-a-zone-create-a-custom-asset

Creates a custom asset for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"
body object Required
body.description — Required $ref: "#/definitions/custom-pages_asset_description"
body.name — Required $ref: "#/definitions/custom-pages_asset_name"
body.url — Required $ref: "#/definitions/custom-pages_asset_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "my_custom_error_page",
    "description": "Custom 500 error page",
    "url": "https://example.com/error.html"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom asset — cloudflare.custom-assets-for-a-zone-delete-a-custom-asset

Deletes a custom asset from a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asset_name — Required $ref: "#/definitions/custom-pages_asset_name"
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asset_name": "my_custom_error_page",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom asset — cloudflare.custom-assets-for-a-zone-get-a-custom-asset

Returns a custom asset for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asset_name — Required $ref: "#/definitions/custom-pages_asset_name"
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asset_name": "my_custom_error_page",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom asset — cloudflare.custom-assets-for-a-zone-update-a-custom-asset

Updates a custom asset for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.asset_name — Required $ref: "#/definitions/custom-pages_asset_name"
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"
body object Required
body.description — Required $ref: "#/definitions/custom-pages_asset_description"
body.url — Required $ref: "#/definitions/custom-pages_asset_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "asset_name": "my_custom_error_page",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "description": "Custom 500 error page",
    "url": "https://example.com/error.html"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a preview token — cloudflare.custom-pages-for-a-zone-create-preview-token

Creates a signed JWT for previewing a zone-level custom page before it is published.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"
body — Required $ref: "#/definitions/custom-pages_preview_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "act": "preview",
    "target": "block:waf",
    "url": "https://example.com/error.html"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom page — cloudflare.custom-pages-for-a-zone-get-a-custom-page

Returns the configuration for a custom page type at the zone level.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/custom-pages_error_page_type"
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ratelimit_block",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom page — cloudflare.custom-pages-for-a-zone-update-a-custom-page

Updates the configuration for a custom page type at the zone level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/custom-pages_error_page_type"
path.zone_id — Required Identifier of the Cloudflare zone. $ref: "#/definitions/custom-pages_identifier"
body object Required
body.state — Required $ref: "#/definitions/custom-pages_state"
body.url — Required $ref: "#/definitions/custom-pages_url"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "ratelimit_block",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "url": "http://www.example.com",
    "state": "default"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve the DCV Delegation unique identifier. — cloudflare.dcv-delegation-uuid-get

Retrieve the account and zone specific unique identifier used as part of the CNAME target for DCV Delegation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get device certificate provisioning status — cloudflare.devices-get-policy-certificates

Fetches device certificate provisioning.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/teams-devices_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update device certificate provisioning status — cloudflare.devices-update-policy-certificates

Enable Zero Trust Clients to provision a certificate, containing a x509 subject, and referenced by Access device posture policies when the client visits MTLS protected domains. This facilitates device posture without a WARP session.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/teams-devices_identifier"
body — Required $ref: "#/definitions/teams-devices_devices_policy_certificates"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DNS Records — cloudflare.dns-records-for-a-zone-list-dns-records

List, search, sort, and filter a zones' DNS records.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"
query object Optional additionalProperties: false
query.name string Optional Exact value of the DNS record name. This is a convenience alias for name.exact.
query.name.exact string Optional Exact value of the DNS record name. Name filters are case-insensitive.
query.name.contains string Optional Substring of the DNS record name. Name filters are case-insensitive.
query.name.startswith string Optional Prefix of the DNS record name. Name filters are case-insensitive.
query.name.endswith string Optional Suffix of the DNS record name. Name filters are case-insensitive.
query.type — Optional $ref: "#/definitions/dns-records_type"
query.content string Optional Exact value of the DNS record content. This is a convenience alias for content.exact.
query.content.exact string Optional Exact value of the DNS record content. Content filters are case-insensitive.
query.content.contains string Optional Substring of the DNS record content. Content filters are case-insensitive.
query.content.startswith string Optional Prefix of the DNS record content. Content filters are case-insensitive.
query.content.endswith string Optional Suffix of the DNS record content. Content filters are case-insensitive.
query.proxied — Optional $ref: "#/definitions/dns-records_proxied"
query.match — Optional $ref: "#/definitions/dns-records_match"
query.comment string Optional Exact value of the DNS record comment. This is a convenience alias for comment.exact.
query.comment.present string Optional If this parameter is present, only records with a comment are returned.
query.comment.absent string Optional If this parameter is present, only records without a comment are returned.
query.comment.exact string Optional Exact value of the DNS record comment. Comment filters are case-insensitive.
query.comment.contains string Optional Substring of the DNS record comment. Comment filters are case-insensitive.
query.comment.startswith string Optional Prefix of the DNS record comment. Comment filters are case-insensitive.
query.comment.endswith string Optional Suffix of the DNS record comment. Comment filters are case-insensitive.
query.tag string Optional Condition on the DNS record tag. Parameter values can be of the form &lt;tag-name&gt;:&lt;tag-value&gt; to search for an exact name:value pair, or just &lt;tag-name&gt; to search for records with a specific tag name regardless of its value. This is a convenience shorthand for the more powerful tag.&lt;predicate&gt; parameters. Examples: - tag=important is equivalent to tag.present=important - tag=team:DNS is equivalent to tag.exact=team:DNS
query.tag.present string Optional Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.
query.tag.absent string Optional Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.
query.tag.exact string Optional A tag and value, of the form &lt;tag-name&gt;:&lt;tag-value&gt;. The API will only return DNS records that have a tag named &lt;tag-name&gt; whose value is &lt;tag-value&gt;. Tag filters are case-insensitive.
query.tag.contains string Optional A tag and value, of the form &lt;tag-name&gt;:&lt;tag-value&gt;. The API will only return DNS records that have a tag named &lt;tag-name&gt; whose value contains &lt;tag-value&gt;. Tag filters are case-insensitive.
query.tag.startswith string Optional A tag and value, of the form &lt;tag-name&gt;:&lt;tag-value&gt;. The API will only return DNS records that have a tag named &lt;tag-name&gt; whose value starts with &lt;tag-value&gt;. Tag filters are case-insensitive.
query.tag.endswith string Optional A tag and value, of the form &lt;tag-name&gt;:&lt;tag-value&gt;. The API will only return DNS records that have a tag named &lt;tag-name&gt; whose value ends with &lt;tag-value&gt;. Tag filters are case-insensitive.
query.search — Optional $ref: "#/definitions/dns-records_search"
query.tag_match — Optional $ref: "#/definitions/dns-records_tag_match"
query.page — Optional $ref: "#/definitions/dns-records_page"
query.per_page — Optional $ref: "#/definitions/dns-records_per_page"
query.order — Optional $ref: "#/definitions/dns-records_order"
query.direction — Optional $ref: "#/definitions/dns-records_direction"
query.include_shadow_metadata boolean Optional Whether to include shadow metadata in the meta field of each record in the response. See Shadowed records. default: false
query.shadowed_by_name string Optional 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.
query.shadowing_name string Optional 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.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch DNS Records — cloudflare.dns-records-for-a-zone-batch-dns-records

Send a Batch of DNS Record API calls to be executed together.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"
query object Optional additionalProperties: false
query.include_shadow_metadata boolean Optional Whether to include shadow metadata in the meta field of each record in the response. See Shadowed records. default: false
body — Required $ref: "#/definitions/dns-records_dns-request-batch-object"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export DNS Records — cloudflare.dns-records-for-a-zone-export-dns-records

You can export your BIND config through this endpoint.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Scanned DNS Records — cloudflare.dns-records-for-a-zone-review-dns-scan

Retrieves the list of DNS records discovered up to this point by the asynchronous scan. These records are temporary until explicitly accepted or rejected via POST /scan/review. Additional records may be discovered by the scan later.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Review Scanned DNS Records — cloudflare.dns-records-for-a-zone-apply-dns-scan-results

Accept or reject DNS records found by the DNS records scan. Accepted records will be permanently added to the zone, while rejected records will be permanently deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"
body — Required $ref: "#/definitions/dns-records_dns-request-review-scan-object"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Trigger DNS Record Scan — cloudflare.dns-records-for-a-zone-trigger-dns-scan

Initiates an asynchronous scan for common DNS records on your domain. Note that this does not automatically add records to your zone. The scan runs in the background, and results can be reviewed later using the /scan/review endpoints. Useful if you haven't updated your nameservers yet.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DNS Record Usage — cloudflare.dns-records-for-a-zone-get-usage

Get the current DNS record usage for a zone, including the number of records and the quota limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete DNS Record — cloudflare.dns-records-for-a-zone-delete-dns-record

Permanently removes a DNS record from the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dns_record_id — Required $ref: "#/definitions/dns-records_identifier"
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dns_record_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

DNS Record Details — cloudflare.dns-records-for-a-zone-dns-record-details

Retrieves details for a specific DNS record in the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dns_record_id — Required $ref: "#/definitions/dns-records_identifier"
path.zone_id — Required $ref: "#/definitions/dns-records_identifier"
query object Optional additionalProperties: false
query.include_shadow_metadata boolean Optional Whether to include shadow metadata in the meta field of each record in the response. See Shadowed records. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dns_record_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Show DNS Settings — cloudflare.dns-settings-for-a-zone-list-dns-settings

Show DNS settings for a zone

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update DNS Settings — cloudflare.dns-settings-for-a-zone-update-dns-settings

Update DNS settings for a zone

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dns-settings_identifier"
body — Required $ref: "#/definitions/dns-settings_dns-settings-zone-patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete DNSSEC records — cloudflare.dnssec-delete-dnssec-records

Delete DNSSEC.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dnssec_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

DNSSEC Details — cloudflare.dnssec-dnssec-details

Details about DNSSEC status and configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dnssec_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit DNSSEC Status — cloudflare.dnssec-edit-dnssec-status

Enable or disable DNSSEC.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dnssec_identifier"
body object Required
body.dnssec_multi_signer — Optional $ref: "#/definitions/dnssec_dnssec_multi_signer"
body.dnssec_presigned — Optional $ref: "#/definitions/dnssec_dnssec_presigned"
body.dnssec_use_nsec3 — Optional $ref: "#/definitions/dnssec_dnssec_use_nsec3"
body.status string Optional Status of DNSSEC, based on user-desired state and presence of necessary records. enum: ["active","disabled"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DNSSEC ZSKs — cloudflare.dnssec-list-dnssec-zsks

List the Zone Signing Keys (ZSKs) that DNSSEC uses for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/dnssec_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get DMARC Report Status — cloudflare.get_dmarc_reports_status

Retrieves the current DMARC report configuration and status for a zone. Returns the RUA prefix, enabled status, approved sources, and DNS records.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone identifier. $ref: "#/definitions/email-auth_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Configure DMARC Reports — cloudflare.configure_dmarc_reports

Updates the DMARC report configuration for a zone. At least one of enabled or skip_wizard must be provided. When enabling, the handler will ensure the DMARC RUA record exists in DNS.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone identifier. $ref: "#/definitions/email-auth_identifier"
body — Required $ref: "#/definitions/email-auth_ConfigureDmarcReportsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Inspect SPF Record — cloudflare.inspect_spf

Inspects a specific SPF TXT record and returns a parsed tree structure in the spflimit-worker format.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone identifier. $ref: "#/definitions/email-auth_identifier"
query object Required additionalProperties: false
query.id string Required DNS record ID (rec_tag) to inspect pattern: "^[a-zA-Z0-9-]{1,64}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "id": "e5bb46707a802688812d5d1c9f7977d4"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Email Routing settings — cloudflare.email-routing-settings-get-email-routing-settings

Get information about the settings for your Email Routing zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Email Routing settings — cloudflare.email-routing-settings-update-email-routing-settings

Update the settings for your Email Routing zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_update_email_routing_settings_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Apply Email Routing settings — cloudflare.email-routing-settings-replace-email-routing-settings

Apply the provided settings to your Email Routing zone. Omitted settings retain their current values, as with PATCH.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_update_email_routing_settings_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable Email Routing — cloudflare.email-routing-settings-disable-email-routing-dns

Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Optional $ref: "#/definitions/email_email_setting_dns_request_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Email Routing - DNS settings — cloudflare.email-routing-settings-email-routing-dns-settings

Show the DNS records needed to configure your Email Routing zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
query object Optional additionalProperties: false
query.subdomain — Optional Deprecated. When supplied, the response shape differs from the documented default and is not modeled in generated SDKs. Do not rely on this parameter. $ref: "#/definitions/email_email_setting_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unlock Email Routing DNS records — cloudflare.email-routing-settings-unlock-email-routing-dns

Unlock MX Records previously locked by Email Routing.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Optional $ref: "#/definitions/email_email_setting_dns_request_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable Email Routing — cloudflare.email-routing-settings-enable-email-routing-dns

Enable your Email Routing zone. Add and lock the necessary MX and SPF records.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Optional $ref: "#/definitions/email_email_setting_dns_request_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List routing rules — cloudflare.email-routing-routing-rules-list-routing-rules

Lists the routing rules that match incoming messages for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.enabled boolean Optional Filter by enabled routing rules. enum: [true,false]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create routing rule — cloudflare.email-routing-routing-rules-create-routing-rule

Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address). Forward actions require exactly one verified destination address.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_create_rule_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "actions": [
      {
        "type": "forward"
      }
    ],
    "matchers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get catch-all rule — cloudflare.email-routing-routing-rules-get-catch-all-rule

Get information on the default catch-all routing rule.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update catch-all rule — cloudflare.email-routing-routing-rules-update-catch-all-rule

Enable or disable catch-all routing rule, or change action to forward to a specific destination address. Forward actions require exactly one verified destination address.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_update_catch_all_rule_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "actions": [
      {
        "type": "forward"
      }
    ],
    "matchers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete routing rule — cloudflare.email-routing-routing-rules-delete-routing-rule

Deletes a routing rule so matching incoming messages are no longer forwarded by it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_identifier — Required $ref: "#/definitions/email_rule_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_identifier": "a7e6fb77503c41d8a7f3113c6918f10c",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get routing rule — cloudflare.email-routing-routing-rules-get-routing-rule

Get information for a specific routing rule already created.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_identifier — Required $ref: "#/definitions/email_rule_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_identifier": "a7e6fb77503c41d8a7f3113c6918f10c",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update routing rule — cloudflare.email-routing-routing-rules-update-routing-rule

Update actions and matches, or enable/disable specific routing rules. Forward actions require exactly one verified destination address.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_identifier — Required $ref: "#/definitions/email_rule_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_update_rule_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_identifier": "a7e6fb77503c41d8a7f3113c6918f10c",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "actions": [
      {
        "type": "forward"
      }
    ],
    "matchers": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List sending subdomains — cloudflare.email-sending-subdomains-list-sending-subdomains

Lists all sending-enabled subdomains for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a sending subdomain — cloudflare.email-sending-subdomains-create-sending-subdomain

Creates a new sending subdomain or re-enables sending on an existing subdomain that had it disabled. If zone-level Email Sending has not been enabled yet, the zone flag is automatically set when the entitlement is present. A leftmost wildcard such as .example.com is accepted only for accounts with wildcard Email Sending enabled. Wildcard senders share the base domain's DKIM signing identity and cf-bounce. return path.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_create_sending_subdomain_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "sub.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview sending subdomain DNS — cloudflare.email-sending-subdomains-preview-sending-subdomain

Returns the DNS records that would be created for a sending subdomain, flags which records are missing, and reports any conflicts with existing DNS records. This is a read-only dry-run — no records are created or modified. Use before or after creating a subdomain to check DNS status. A leftmost wildcard requires wildcard Email Sending to be enabled for the account and previews base-scoped DKIM and return-path records.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_create_sending_subdomain_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "sub.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a sending subdomain — cloudflare.email-sending-subdomains-delete-sending-subdomain

Disables sending on a subdomain and removes its DNS records. If routing is still active on the subdomain, only sending is disabled.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subdomain_id — Required $ref: "#/definitions/email_sending_subdomain_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subdomain_id": "aabbccdd11223344aabbccdd11223344",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a sending subdomain — cloudflare.email-sending-subdomains-get-sending-subdomain

Gets information for a specific sending subdomain.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subdomain_id — Required $ref: "#/definitions/email_sending_subdomain_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subdomain_id": "aabbccdd11223344aabbccdd11223344",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a sending subdomain — cloudflare.email-sending-subdomains-update-sending-subdomain

Updates the activity-log preview preference for a sending subdomain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subdomain_id — Required $ref: "#/definitions/email_sending_subdomain_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"
body — Required $ref: "#/definitions/email_update_sending_subdomain_properties"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subdomain_id": "aabbccdd11223344aabbccdd11223344",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "preview_enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get sending subdomain DNS records — cloudflare.email-sending-subdomains-get-sending-subdomain-dns

Returns the expected DNS records for a sending subdomain.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subdomain_id — Required $ref: "#/definitions/email_sending_subdomain_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subdomain_id": "aabbccdd11223344aabbccdd11223344",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Fix sending subdomain DNS records — cloudflare.email-sending-subdomains-fix-sending-subdomain-dns

Idempotently re-applies the sending DNS records (creates missing records, re-applies the email_routing lock on records whose lock has been cleared). Refuses with a 409 if foreign MX, multiple SPF, multiple DMARC, or multiple DKIM records exist at the relevant DNS names — those require manual cleanup.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subdomain_id — Required $ref: "#/definitions/email_sending_subdomain_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subdomain_id": "aabbccdd11223344aabbccdd11223344",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get sending subdomain DNS status — cloudflare.email-sending-subdomains-get-sending-subdomain-dns-status

Returns the desired DNS records for a sending subdomain along with a live diff against actual DNS state. Use this to detect missing, unlocked, foreign, or multi-record conflicts before deciding whether to call the fix endpoint. For wildcard sending rows, each call also rechecks the governing organizational-domain DMARC policy and reports policy drift that DNS Fix cannot repair.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subdomain_id — Required $ref: "#/definitions/email_sending_subdomain_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subdomain_id": "aabbccdd11223344aabbccdd11223344",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get sending subdomain complaint count — cloudflare.email-sending-subdomains-get-sending-subdomain-reputation-complaints

Returns the matched complaint count for a sending subdomain in a half-open time window of up to seven days.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subdomain_id — Required $ref: "#/definitions/email_sending_subdomain_identifier"
path.zone_id — Required $ref: "#/definitions/email_identifier"
query object Required additionalProperties: false
query.start_at string Required format: "date-time"
query.end_at string Required format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subdomain_id": "aabbccdd11223344aabbccdd11223344",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "start_at": "2026-01-01T00:00:00Z",
    "end_at": "2026-01-01T00:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zone Entitlements — cloudflare.entitlements-get-zone-entitlements

Returns the list of entitlements (features and their allocations) for a given zone. Each entitlement describes a product feature the zone is permitted to use and the allocation value (boolean, count, range, enum, or string) that governs its behaviour.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier of the zone. $ref: "#/definitions/entitlements_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List zone environments — cloudflare.zonesenvironmentslist

Lists configured environments for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Partially update zone environments — cloudflare.zonesenvironmentsedit

Applies partial updates to zone environments.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.
body — Required $ref: "#/definitions/kamino_environments_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": {
    "environments": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create zone environments — cloudflare.zonesenvironmentscreate

Creates environments for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.
body — Required $ref: "#/definitions/kamino_environments_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": {
    "environments": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upsert zone environments — cloudflare.zonesenvironmentsupdate

Replaces the full environment configuration for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.
body — Required $ref: "#/definitions/kamino_environments_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": {
    "environments": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete zone environment — cloudflare.zonesenvironmentsdelete

Deletes a zone environment by reference identifier.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.
path.environment_id string Required Reference identifier for the environment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example",
    "environment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Invalidate Cached Content by Environment — cloudflare.zone-environment-invalidate

Marks cached content as stale for one environment of the zone. Content cached for the zone's other environments, including production, is not affected. Otherwise this works like POST /zones/{zone_id}/invalidate_cache: the next request for invalidated content makes Cloudflare revalidate it with your origin, and the request body takes the same fields.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The zone ID. $ref: "#/definitions/cache-purge_identifier"
path.environment_id — Required The environment ID, from Version Management. $ref: "#/definitions/cache-purge_identifier"
body — Required
body — Required anyOf[1]; $ref: "#/definitions/cache-purge_FlexPurgeByTags"
body — Required anyOf[2]; $ref: "#/definitions/cache-purge_FlexPurgeByHostnames"
body — Required anyOf[3]; $ref: "#/definitions/cache-purge_FlexPurgeByPrefixes"
body — Required anyOf[4]; $ref: "#/definitions/cache-purge_Everything"
body — Required anyOf[5]; $ref: "#/definitions/cache-purge_SingleFile"
body — Required anyOf[6]; $ref: "#/definitions/cache-purge_SingleFileWithUrlAndHeaders"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "environment_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "tags": [
      "product-1234",
      "homepage"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge Cached Content by Environment — cloudflare.zone-environment-purge

Deletes cached content for one environment of the zone. Content cached for the zone's other environments, including production, is not affected. Otherwise this works like POST /zones/{zone_id}/purge_cache: the next request for purged content is a cache MISS, and the request body takes the same fields.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The zone ID. $ref: "#/definitions/cache-purge_identifier"
path.environment_id — Required The environment ID, from Version Management. $ref: "#/definitions/cache-purge_identifier"
body — Required
body — Required anyOf[1]; $ref: "#/definitions/cache-purge_FlexPurgeByTags"
body — Required anyOf[2]; $ref: "#/definitions/cache-purge_FlexPurgeByHostnames"
body — Required anyOf[3]; $ref: "#/definitions/cache-purge_FlexPurgeByPrefixes"
body — Required anyOf[4]; $ref: "#/definitions/cache-purge_Everything"
body — Required anyOf[5]; $ref: "#/definitions/cache-purge_SingleFile"
body — Required anyOf[6]; $ref: "#/definitions/cache-purge_SingleFileWithUrlAndHeaders"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "environment_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "tags": [
      "product-1234",
      "homepage"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Roll back zone environment — cloudflare.zonesenvironmentsrollback

Rolls a zone environment back to its previous version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Identifier of the zone.
path.environment_id string Required Reference identifier for the environment.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example",
    "environment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IP Access rules — cloudflare.ip-access-rules-for-a-zone-list-ip-access-rules

Fetches IP Access rules of a zone. You can filter the results using several optional parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
query object Optional additionalProperties: false
query.mode — Optional $ref: "#/definitions/firewall_schemas-mode"
query.configuration.target string Optional The target to search in existing rules. enum: ["ip","ip_range","asn","country"]
query.configuration.value string Optional The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided configuration.target. Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
query.notes string Optional The string to search for in the notes of existing IP Access rules. Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
query.match string Optional When set to all, all the search requirements must match. When set to any, only one of the search requirements has to match. enum: ["any","all"]; default: "all"
query.page number Optional Requested page within paginated list of results.
query.per_page number Optional Maximum number of results requested.
query.order string Optional The field used to sort returned rules. enum: ["configuration.target","configuration.value","mode"]
query.direction string Optional The direction used to sort returned rules. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an IP Access rule — cloudflare.ip-access-rules-for-a-zone-delete-an-ip-access-rule

Deletes an IP Access rule defined at the zone level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
path.rule_id — Required $ref: "#/definitions/firewall_rule_identifier"
body object Required
body.cascade string Optional The level to attempt to delete similar rules defined for other zones with the same owner. The default value is none, which will only delete the current rule. Using basic will delete rules that match the same action (mode) and configuration, while using aggressive will delete rules that match the same configuration. enum: ["none","basic","aggressive"]; default: "none"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an IP Access rule — cloudflare.ip-access-rules-for-a-zone-update-an-ip-access-rule

Updates an IP Access rule defined at the zone level. You can only update the rule action (mode parameter) and notes.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
path.rule_id — Required $ref: "#/definitions/firewall_rule_identifier"
body object Required
body.mode — Optional
body.mode — Optional allOf[1]; $ref: "#/definitions/firewall_schemas-mode"
body.notes — Optional $ref: "#/definitions/firewall_notes"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zone Lockdown rules — cloudflare.zone-lockdown-list-zone-lockdown-rules

Fetches Zone Lockdown rules. You can filter the results using several optional parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.description — Optional
query.description — Optional allOf[1]; $ref: "#/definitions/firewall_schemas-description_search"
query.modified_on — Optional
query.modified_on — Optional allOf[1]; $ref: "#/definitions/firewall_modified_on"
query.ip — Optional
query.ip — Optional allOf[1]; $ref: "#/definitions/firewall_ip_search"
query.priority — Optional
query.priority — Optional allOf[1]; $ref: "#/definitions/firewall_schemas-priority"
query.uri_search — Optional
query.uri_search — Optional allOf[1]; $ref: "#/definitions/firewall_uri_search"
query.ip_range_search — Optional
query.ip_range_search — Optional allOf[1]; $ref: "#/definitions/firewall_ip_range_search"
query.per_page number Optional The maximum number of results per page. You can only set the value to 1 or to a multiple of 5 such as 5, 10, 15, or 20. default: 20; minimum: 1; maximum: 1000
query.created_on string Optional The timestamp of when the rule was created. format: "date-time"
query.description_search string Optional A string to search for in the description of existing rules.
query.ip_search string Optional A single IP address to search for in existing rules.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Zone Lockdown rule — cloudflare.zone-lockdown-create-a-zone-lockdown-rule

Creates a new Zone Lockdown rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
body object Required
body.configurations — Required $ref: "#/definitions/firewall_configurations"
body.description — Optional $ref: "#/definitions/firewall_description"
body.paused — Optional $ref: "#/definitions/firewall_schemas-paused"
body.priority — Optional $ref: "#/definitions/firewall_schemas-priority"
body.urls — Required $ref: "#/definitions/firewall_urls"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "urls": [],
    "configurations": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Zone Lockdown rule — cloudflare.zone-lockdown-delete-a-zone-lockdown-rule

Deletes an existing Zone Lockdown rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.lock_downs_id — Required $ref: "#/definitions/firewall_lockdowns_components-schemas-id"
path.zone_id — Required $ref: "#/definitions/firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "lock_downs_id": "372e67954025e0ba6aaa6d586b9e0b59",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Zone Lockdown rule — cloudflare.zone-lockdown-get-a-zone-lockdown-rule

Fetches the details of a Zone Lockdown rule.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.lock_downs_id — Required $ref: "#/definitions/firewall_lockdowns_components-schemas-id"
path.zone_id — Required $ref: "#/definitions/firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "lock_downs_id": "372e67954025e0ba6aaa6d586b9e0b59",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Zone Lockdown rule — cloudflare.zone-lockdown-update-a-zone-lockdown-rule

Updates an existing Zone Lockdown rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.lock_downs_id — Required $ref: "#/definitions/firewall_lockdowns_components-schemas-id"
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
body object Required
body.configurations — Required $ref: "#/definitions/firewall_configurations"
body.urls — Required $ref: "#/definitions/firewall_urls"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "lock_downs_id": "372e67954025e0ba6aaa6d586b9e0b59",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "urls": [],
    "configurations": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete the payload logging key — cloudflare.payload-logging-keys-for-a-zone-delete-the-payload-logging-key

Deletes the payload logging public key of the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the payload logging key — cloudflare.payload-logging-keys-for-a-zone-get-the-payload-logging-key

Fetches the public key that payload logging uses to encrypt matched payloads for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set the payload logging key — cloudflare.payload-logging-keys-for-a-zone-set-the-payload-logging-key

Creates or replaces the public key that payload logging uses to encrypt matched payloads for the zone. The zone key takes precedence over the account key. Requires a plan that includes payload logging (Enterprise); otherwise it returns 403.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
body — Required $ref: "#/definitions/firewall_payload_logging_key"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "public_key": "Ycig/Zr/pZmklmFUN99nr+taURlYItL91g+NcHGYpB8="
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List User Agent Blocking rules — cloudflare.user-agent-blocking-rules-list-user-agent-blocking-rules

Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.description — Optional
query.description — Optional allOf[1]; $ref: "#/definitions/firewall_description_search"
query.per_page number Optional The maximum number of results per page. You can only set the value to 1 or to a multiple of 5 such as 5, 10, 15, or 20. default: 20; minimum: 1; maximum: 1000
query.user_agent string Optional A string to search for in the user agent values of existing rules.
query.paused boolean Optional When true, indicates that the rule is currently paused.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a User Agent Blocking rule — cloudflare.user-agent-blocking-rules-create-a-user-agent-blocking-rule

Creates a new User Agent Blocking rule in a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/firewall_identifier"
body object Required
body.configuration — Required $ref: "#/definitions/firewall_ua_configuration"
body.description — Optional $ref: "#/definitions/firewall_description"
body.mode — Required
body.mode — Required allOf[1]; $ref: "#/definitions/firewall_schemas-mode"
body.paused — Optional $ref: "#/definitions/firewall_schemas-paused"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "mode": "challenge",
    "configuration": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a User Agent Blocking rule — cloudflare.user-agent-blocking-rules-delete-a-user-agent-blocking-rule

Deletes an existing User Agent Blocking rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ua_rule_id — Required $ref: "#/definitions/firewall_components-ua-rule-id"
path.zone_id — Required $ref: "#/definitions/firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ua_rule_id": "372e67954025e0ba6aaa6d586b9e0b59",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a User Agent Blocking rule — cloudflare.user-agent-blocking-rules-get-a-user-agent-blocking-rule

Fetches the details of a User Agent Blocking rule.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ua_rule_id — Required $ref: "#/definitions/firewall_components-ua-rule-id"
path.zone_id — Required $ref: "#/definitions/firewall_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ua_rule_id": "372e67954025e0ba6aaa6d586b9e0b59",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Fraud Detection Settings — cloudflare.fraud-detection-zone-get-settings

Retrieve Fraud Detection settings for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/fraud_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Fraud Detection Settings — cloudflare.fraud-detection-zone-update-settings

Update Fraud Detection settings for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/fraud_identifier"
body — Required $ref: "#/definitions/fraud_fraud_settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Health Checks — cloudflare.health-checks-list-health-checks

List configured health checks.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. Must be a multiple of 5. default: 25; minimum: 5; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Health Check — cloudflare.health-checks-create-health-check

Create a new health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"
body — Required $ref: "#/definitions/healthchecks_query_healthcheck"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "server-1",
    "address": "www.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Preview Health Check — cloudflare.health-checks-create-preview-health-check

Create a new preview health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"
body — Required $ref: "#/definitions/healthchecks_query_healthcheck"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "server-1",
    "address": "www.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Preview Health Check — cloudflare.health-checks-delete-preview-health-check

Delete a health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/healthchecks_identifier"
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Health Check Preview Details — cloudflare.health-checks-health-check-preview-details

Fetch a single configured health check preview.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/healthchecks_identifier"
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Health Check — cloudflare.health-checks-delete-health-check

Delete a health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/healthchecks_identifier"
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Health Check Details — cloudflare.health-checks-health-check-details

Fetch a single configured health check.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/healthchecks_identifier"
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Health Check — cloudflare.health-checks-patch-health-check

Patch a configured health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/healthchecks_identifier"
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"
body — Required $ref: "#/definitions/healthchecks_query_healthcheck"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "server-1",
    "address": "www.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Health Check — cloudflare.health-checks-update-health-check

Update a configured health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/healthchecks_identifier"
path.zone_id — Required $ref: "#/definitions/healthchecks_identifier"
body — Required $ref: "#/definitions/healthchecks_query_healthcheck"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "server-1",
    "address": "www.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Zone Hold — cloudflare.zones-0-hold-delete

Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the creation and activation of zones with this zone's hostname. Existing zone holds can be removed from CDN-only zones when hold_after is not provided. Active holds are automatically disabled when a zone transitions to CDN-only mode.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone ID $ref: "#/definitions/zones_identifier-2"
query object Optional additionalProperties: false
query.hold_after string Optional If hold_after is provided, the hold will be temporarily disabled, then automatically re-enabled by the system at the time specified in this RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely. hold_after cannot be provided for CDN-only zones.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zone Hold — cloudflare.zones-0-hold-get

Retrieve whether the zone is subject to a zone hold, and metadata about the hold.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone ID $ref: "#/definitions/zones_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zone Hold — cloudflare.zones-0-hold-patch

Update the hold_after and/or include_subdomains values on an existing zone hold. The hold is enabled if the hold_after date-time value is in the past. Existing zone holds can be removed from CDN-only zones by setting hold_after to null. Other zone hold updates cannot be made on CDN-only zones. Active holds are automatically disabled when a zone transitions to CDN-only mode.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone ID $ref: "#/definitions/zones_identifier-2"
body object Required
body.hold_after string | null Optional If hold_after is provided and future-dated, the hold will be temporarily disabled, then automatically re-enabled by the system at the time specified in this RFC3339-formatted timestamp. A past-dated hold_after value will have no effect on an existing, enabled hold. Providing an empty string will set its value to the current time. Providing null will disable the hold indefinitely. default: ""
body.include_subdomains boolean Optional If true, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname 'example.com' and include_subdomains=true will block 'example.com', 'staging.example.com', 'api.staging.example.com', etc. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Zone Hold — cloudflare.zones-0-hold-post

Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname. Zone holds cannot be enabled on CDN-only zones.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Zone ID $ref: "#/definitions/zones_identifier-2"
query object Optional additionalProperties: false
query.include_subdomains boolean Optional If provided, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname 'example.com' and include_subdomains=true will block 'example.com', 'staging.example.com', 'api.staging.example.com', etc.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List TLS setting for hostnames — cloudflare.per-hostname-tls-settings-list

List the requested TLS setting for the hostnames under this zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
path.setting_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_setting_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "setting_id": "ciphers"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete TLS setting for hostname — cloudflare.per-hostname-tls-settings-delete

Delete the tls setting value for the hostname.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
path.setting_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_setting_id"
path.hostname — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "setting_id": "ciphers",
    "hostname": "app.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get TLS setting for hostname — cloudflare.per-hostname-tls-settings-get

Get the requested TLS setting for the hostname.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
path.setting_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_setting_id"
path.hostname — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "setting_id": "ciphers",
    "hostname": "app.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit TLS setting for hostname — cloudflare.per-hostname-tls-settings-put

Update the tls setting value for the hostname.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
path.setting_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_setting_id"
path.hostname — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname-3"
body object Required
body.value — Required $ref: "#/definitions/tls-certificates-and-hostnames_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "setting_id": "ciphers",
    "hostname": "app.example.com"
  },
  "body": {
    "value": [
      "ECDHE-RSA-AES128-GCM-SHA256",
      "AES128-GCM-SHA256"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get transformation flows — cloudflare.get_flowsget

Get the current transformation flows configuration for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Zone identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update transformation flows — cloudflare.put_flowsupdate

Replace the entire transformation flows configuration for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Zone identifier.
body object Optional
body.etag string Optional
body.flows array Required maxItems: 10
body.flows[] — Optional
body.flows[] object Optional oneOf[1]
body.flows[].enabled boolean Required oneOf[1]
body.flows[].provider string Required oneOf[1]; enum: ["fastly"]
body.flows[].type string Required oneOf[1]; enum: ["provider"]
body.flows[].version number Required oneOf[1]
body.flows[] object Optional oneOf[2]
body.flows[].enabled boolean Required oneOf[2]
body.flows[].name string Required oneOf[2]
body.flows[].transformations array Required oneOf[2]
body.flows[].transformations[] object Optional oneOf[2]
body.flows[].transformations[].key string Required oneOf[2]
body.flows[].transformations[].value string Required oneOf[2]
body.flows[].trigger — Required oneOf[2]
body.flows[].trigger object Required oneOf[2]; oneOf[1]
body.flows[].trigger.triggers array Required oneOf[2]; oneOf[1]; minItems: 1
body.flows[].trigger.triggers[] object Optional oneOf[2]; oneOf[1]
body.flows[].trigger.type string Required oneOf[2]; oneOf[1]; enum: ["and"]
body.flows[].trigger object Required oneOf[2]; oneOf[2]
body.flows[].trigger.triggers array Required oneOf[2]; oneOf[2]; minItems: 1
body.flows[].trigger.triggers[] object Optional oneOf[2]; oneOf[2]
body.flows[].trigger.type string Required oneOf[2]; oneOf[2]; enum: ["or"]
body.flows[].trigger object Required oneOf[2]; oneOf[3]
body.flows[].trigger.paths array Required oneOf[2]; oneOf[3]
body.flows[].trigger.paths[] string Optional oneOf[2]; oneOf[3]
body.flows[].trigger.type string Required oneOf[2]; oneOf[3]; enum: ["path"]
body.flows[].trigger object Required oneOf[2]; oneOf[4]
body.flows[].trigger.extensions array Required oneOf[2]; oneOf[4]
body.flows[].trigger.extensions[] string Optional oneOf[2]; oneOf[4]
body.flows[].trigger.type string Required oneOf[2]; oneOf[4]; enum: ["extension"]
body.flows[].trigger object Required oneOf[2]; oneOf[5]
body.flows[].trigger.params array Required oneOf[2]; oneOf[5]
body.flows[].trigger.params[] object Optional oneOf[2]; oneOf[5]
body.flows[].trigger.params[].key string Required oneOf[2]; oneOf[5]
body.flows[].trigger.params[].value string Required oneOf[2]; oneOf[5]
body.flows[].trigger.type string Required oneOf[2]; oneOf[5]; enum: ["query-param"]
body.flows[].type string Required oneOf[2]; enum: ["custom"]
body.version number Required enum: [2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an ingress rule — cloudflare.sinkhole-config-create-ingress

Create a new ingress rule for the specified sinkhole. The CIDR block must be a Cloudflare BYOIP associated with your account. The zone_id must be a zone with the ability to create Spectrum Apps. The sinkhole must belong to the same account as the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The unique identifier for the Cloudflare zone. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.
body — Required $ref: "#/definitions/intel-sinkholes_ingress_create_params"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c"
  },
  "body": {
    "cidr": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an ingress rule — cloudflare.sinkhole-config-delete-ingress

Delete the specified ingress rule. The sinkhole must belong to the same account as the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The unique identifier for the Cloudflare zone. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.
path.ingress_id string Required The unique identifier for the ingress rule.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c",
    "ingress_id": "de32ae5203724ed08dcc26e971a4d22f"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an ingress rule — cloudflare.sinkhole-config-get-ingress

Get the specified ingress rule associated with a sinkhole. The sinkhole must belong to the same account as the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The unique identifier for the Cloudflare zone. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.
path.ingress_id string Required The unique identifier for the ingress rule.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c",
    "ingress_id": "de32ae5203724ed08dcc26e971a4d22f"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an ingress rule — cloudflare.sinkhole-config-update-ingress

Replaces the specified ingress rule. The sinkhole must belong to the same account as the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The unique identifier for the Cloudflare zone. $ref: "#/definitions/intel-sinkholes_identifier"
path.sinkhole_id string Required The unique identifier for the sinkhole.
path.ingress_id string Required The unique identifier for the ingress rule.
body — Required $ref: "#/definitions/intel-sinkholes_ingress_create_params"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c",
    "ingress_id": "de32ae5203724ed08dcc26e971a4d22f"
  },
  "body": {
    "cidr": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Invalidate Cached Content — cloudflare.zone-invalidate

Marks cached content as stale in every Cloudflare data center and cache tier, including Cache Reserve. The content stays in cache. The next request for it makes Cloudflare revalidate it with your origin, using the ETag and Last-Modified values it was cached with:

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The zone ID. $ref: "#/definitions/cache-purge_identifier"
body — Required
body — Required anyOf[1]; $ref: "#/definitions/cache-purge_FlexPurgeByTags"
body — Required anyOf[2]; $ref: "#/definitions/cache-purge_FlexPurgeByHostnames"
body — Required anyOf[3]; $ref: "#/definitions/cache-purge_FlexPurgeByPrefixes"
body — Required anyOf[4]; $ref: "#/definitions/cache-purge_Everything"
body — Required anyOf[5]; $ref: "#/definitions/cache-purge_SingleFile"
body — Required anyOf[6]; $ref: "#/definitions/cache-purge_SingleFileWithUrlAndHeaders"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "tags": [
      "product-1234",
      "homepage"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Keyless SSL Configurations — cloudflare.keyless-ssl-for-a-zone-list-keyless-ssl-configurations

List all Keyless SSL configurations for a given zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-create-keyless-ssl-configuration

Creates a Keyless SSL configuration that allows SSL/TLS termination without exposing private keys to Cloudflare. Keys remain on your infrastructure.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.bundle_method — Optional $ref: "#/definitions/tls-certificates-and-hostnames_bundle_method"
body.certificate — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate-2"
body.host — Required $ref: "#/definitions/tls-certificates-and-hostnames_host"
body.name — Optional $ref: "#/definitions/tls-certificates-and-hostnames_name_write"
body.port — Required $ref: "#/definitions/tls-certificates-and-hostnames_port"
body.tunnel — Optional $ref: "#/definitions/tls-certificates-and-hostnames_keyless_tunnel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "host": "example.com",
    "port": 24008,
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV\nBAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF\nMQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ\nLIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N\nnTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO\nfSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8\n5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ\nqI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+\nsWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV\nRKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4\nUEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt\nvTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8\nuXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs\nESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8\n/cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw=\n-----END CERTIFICATE-----"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-delete-keyless-ssl-configuration

Removes a Keyless SSL configuration. SSL connections will no longer use the keyless server for cryptographic operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.keyless_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_keyless_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "keyless_certificate_id": "4d2844d2ce78891c34d0b6c0535a291e",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-get-keyless-ssl-configuration

Get details for one Keyless SSL configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.keyless_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_keyless_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "keyless_certificate_id": "4d2844d2ce78891c34d0b6c0535a291e",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Keyless SSL Configuration — cloudflare.keyless-ssl-for-a-zone-edit-keyless-ssl-configuration

This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.keyless_certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_keyless_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.enabled — Optional $ref: "#/definitions/tls-certificates-and-hostnames_enabled_write"
body.host — Optional $ref: "#/definitions/tls-certificates-and-hostnames_host"
body.name — Optional $ref: "#/definitions/tls-certificates-and-hostnames_name_write"
body.port — Optional $ref: "#/definitions/tls-certificates-and-hostnames_port"
body.tunnel — Optional $ref: "#/definitions/tls-certificates-and-hostnames_keyless_tunnel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "keyless_certificate_id": "4d2844d2ce78891c34d0b6c0535a291e",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Leaked Credential Checks status for a zone. — cloudflare.waf-product-api-leaked-credentials-get-status

Get the current Leaked Credential Checks status for the zone. While enabled, Cloudflare scans incoming requests for usernames and passwords that were exposed in known data breaches.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the Leaked Credential Checks status for a zone. — cloudflare.waf-product-api-leaked-credentials-set-status

Update the Leaked Credential Checks status for the zone, enabling or disabling the detection. While enabled, the detection populates the cf.waf.credential_check. fields, which you can reference in custom rules and rate limiting rules to challenge or block requests carrying compromised credentials.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
body — Required $ref: "#/definitions/waf-product-api-bundle_status"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List the custom detection locations of a zone. — cloudflare.waf-product-api-leaked-credentials-list-detections

List the user-defined detection locations configured for Leaked Credential Checks, each with its own identifier. A custom detection location tells the WAF where to find the username and password in requests to your application.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom detection location for a zone. — cloudflare.waf-product-api-leaked-credentials-create-detection

Create a detection location for credentials that the default scan locations do not cover, using Rules language expressions such as lookup_json_string(http.request.body.raw, "user"). Only the username expression is required, and Leaked Credential Checks must be enabled on the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
body — Required $ref: "#/definitions/waf-product-api-bundle_custom-detection"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a custom detection location from a zone. — cloudflare.waf-product-api-leaked-credentials-delete-detection

Delete a user-defined detection location, identified by its detection ID. Incoming requests are then scanned using only the default scan locations and the detection locations that remain.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
path.detection_id — Required $ref: "#/definitions/waf-product-api-bundle_detection-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "detection_id": "18a14bafaa8eb1df04ce683ec18c765e"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a custom detection location of a zone. — cloudflare.waf-product-api-leaked-credentials-get-detection

Get the username and password expressions of a single user-defined detection location, identified by its detection ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
path.detection_id — Required $ref: "#/definitions/waf-product-api-bundle_detection-id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "detection_id": "18a14bafaa8eb1df04ce683ec18c765e"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a custom detection location of a zone. — cloudflare.waf-product-api-leaked-credentials-update-detection

Update the username and password expressions of an existing detection location, identified by its detection ID. Both expressions are overwritten, so omitting the password expression clears it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waf-product-api-bundle_identifier"
path.detection_id — Required $ref: "#/definitions/waf-product-api-bundle_detection-id"
body — Required $ref: "#/definitions/waf-product-api-bundle_custom-detection"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "detection_id": "18a14bafaa8eb1df04ce683ec18c765e"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Load Balancers — cloudflare.load-balancers-list-load-balancers

List configured load balancers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Load Balancer — cloudflare.load-balancers-create-load-balancer

Create a new load balancer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
body object Required
body.adaptive_routing — Optional $ref: "#/definitions/load-balancing_adaptive_routing"
body.country_pools — Optional $ref: "#/definitions/load-balancing_country_pools"
body.default_pools — Required $ref: "#/definitions/load-balancing_default_pools"
body.description — Optional $ref: "#/definitions/load-balancing_components-schemas-description"
body.fallback_pool — Required $ref: "#/definitions/load-balancing_fallback_pool"
body.location_strategy — Optional $ref: "#/definitions/load-balancing_location_strategy"
body.name — Required $ref: "#/definitions/load-balancing_components-schemas-name"
body.networks — Optional $ref: "#/definitions/load-balancing_networks"
body.pop_pools — Optional $ref: "#/definitions/load-balancing_pop_pools"
body.proxied — Optional $ref: "#/definitions/load-balancing_proxied"
body.random_steering — Optional $ref: "#/definitions/load-balancing_random_steering"
body.region_pools — Optional $ref: "#/definitions/load-balancing_region_pools"
body.rules — Optional $ref: "#/definitions/load-balancing_rules"
body.session_affinity — Optional $ref: "#/definitions/load-balancing_session_affinity"
body.session_affinity_attributes — Optional $ref: "#/definitions/load-balancing_session_affinity_attributes"
body.session_affinity_ttl — Optional $ref: "#/definitions/load-balancing_session_affinity_ttl"
body.steering_policy — Optional $ref: "#/definitions/load-balancing_steering_policy"
body.ttl — Optional $ref: "#/definitions/load-balancing_ttl"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "www.example.com",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "fallback_pool": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Load Balancer — cloudflare.load-balancers-delete-load-balancer

Delete a configured load balancer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
path.load_balancer_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252",
    "load_balancer_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Load Balancer Details — cloudflare.load-balancers-load-balancer-details

Fetch a single configured load balancer.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
path.load_balancer_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252",
    "load_balancer_id": "699d98642c564d2e855e9661899b7252"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Load Balancer — cloudflare.load-balancers-patch-load-balancer

Apply changes to an existing load balancer, overwriting the supplied properties.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
path.load_balancer_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
body object Required
body.adaptive_routing — Optional $ref: "#/definitions/load-balancing_adaptive_routing"
body.country_pools — Optional $ref: "#/definitions/load-balancing_country_pools"
body.default_pools — Optional $ref: "#/definitions/load-balancing_default_pools"
body.description — Optional $ref: "#/definitions/load-balancing_components-schemas-description"
body.enabled — Optional $ref: "#/definitions/load-balancing_components-schemas-enabled"
body.fallback_pool — Optional $ref: "#/definitions/load-balancing_fallback_pool"
body.location_strategy — Optional $ref: "#/definitions/load-balancing_location_strategy"
body.name — Optional $ref: "#/definitions/load-balancing_components-schemas-name"
body.pop_pools — Optional $ref: "#/definitions/load-balancing_pop_pools"
body.proxied — Optional $ref: "#/definitions/load-balancing_proxied"
body.random_steering — Optional $ref: "#/definitions/load-balancing_random_steering"
body.region_pools — Optional $ref: "#/definitions/load-balancing_region_pools"
body.rules — Optional $ref: "#/definitions/load-balancing_rules"
body.session_affinity — Optional $ref: "#/definitions/load-balancing_session_affinity"
body.session_affinity_attributes — Optional $ref: "#/definitions/load-balancing_session_affinity_attributes"
body.session_affinity_ttl — Optional $ref: "#/definitions/load-balancing_session_affinity_ttl"
body.steering_policy — Optional $ref: "#/definitions/load-balancing_steering_policy"
body.ttl — Optional $ref: "#/definitions/load-balancing_ttl"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252",
    "load_balancer_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Load Balancer — cloudflare.load-balancers-update-load-balancer

Update a configured load balancer.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
path.load_balancer_id — Required $ref: "#/definitions/load-balancing_load-balancer_components-schemas-identifier"
body object Required
body.adaptive_routing — Optional $ref: "#/definitions/load-balancing_adaptive_routing"
body.country_pools — Optional $ref: "#/definitions/load-balancing_country_pools"
body.default_pools — Required $ref: "#/definitions/load-balancing_default_pools"
body.description — Optional $ref: "#/definitions/load-balancing_components-schemas-description"
body.enabled — Optional $ref: "#/definitions/load-balancing_components-schemas-enabled"
body.fallback_pool — Required $ref: "#/definitions/load-balancing_fallback_pool"
body.location_strategy — Optional $ref: "#/definitions/load-balancing_location_strategy"
body.name — Required $ref: "#/definitions/load-balancing_components-schemas-name"
body.networks — Optional $ref: "#/definitions/load-balancing_networks"
body.pop_pools — Optional $ref: "#/definitions/load-balancing_pop_pools"
body.proxied — Optional $ref: "#/definitions/load-balancing_proxied"
body.random_steering — Optional $ref: "#/definitions/load-balancing_random_steering"
body.region_pools — Optional $ref: "#/definitions/load-balancing_region_pools"
body.rules — Optional $ref: "#/definitions/load-balancing_rules"
body.session_affinity — Optional $ref: "#/definitions/load-balancing_session_affinity"
body.session_affinity_attributes — Optional $ref: "#/definitions/load-balancing_session_affinity_attributes"
body.session_affinity_ttl — Optional $ref: "#/definitions/load-balancing_session_affinity_ttl"
body.steering_policy — Optional $ref: "#/definitions/load-balancing_steering_policy"
body.ttl — Optional $ref: "#/definitions/load-balancing_ttl"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "699d98642c564d2e855e9661899b7252",
    "load_balancer_id": "699d98642c564d2e855e9661899b7252"
  },
  "body": {
    "name": "www.example.com",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "fallback_pool": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List fields — cloudflare.get-zones-zone_id-logpush-datasets-dataset_id-fields

Lists all fields available for a dataset. The response result is. an object with key-value pairs, where keys are field names, and values are descriptions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dataset_id — Required $ref: "#/definitions/logpush_dataset"
path.zone_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dataset_id": "http_requests",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Logpush jobs for a dataset — cloudflare.get-zones-zone_id-logpush-datasets-dataset_id-jobs

Lists Logpush jobs for a zone for a dataset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.dataset_id — Required $ref: "#/definitions/logpush_dataset"
path.zone_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "dataset_id": "http_requests",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Instant Logs jobs — cloudflare.get-zones-zone_id-logpush-edge-jobs

Lists Instant Logs jobs for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Instant Logs job — cloudflare.post-zones-zone_id-logpush-edge-jobs

Creates a new Instant Logs job for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.fields — Optional $ref: "#/definitions/logpush_fields"
body.filter — Optional $ref: "#/definitions/logpush_filter-2"
body.sample — Optional $ref: "#/definitions/logpush_sample"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Logpush jobs — cloudflare.get-zones-zone_id-logpush-jobs

Lists Logpush jobs for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Logpush job — cloudflare.post-zones-zone_id-logpush-jobs

Creates a new Logpush job for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.dataset — Optional $ref: "#/definitions/logpush_dataset"
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"
body.enabled — Optional $ref: "#/definitions/logpush_enabled"
body.filter — Optional $ref: "#/definitions/logpush_filter"
body.filter_attack_traffic — Optional $ref: "#/definitions/logpush_filter_attack_traffic"
body.frequency — Optional $ref: "#/definitions/logpush_frequency"
body.kind — Optional $ref: "#/definitions/logpush_kind"
body.logpull_options — Optional $ref: "#/definitions/logpush_logpull_options"
body.max_upload_bytes — Optional $ref: "#/definitions/logpush_max_upload_bytes"
body.max_upload_interval_seconds — Optional $ref: "#/definitions/logpush_max_upload_interval_seconds"
body.max_upload_records — Optional $ref: "#/definitions/logpush_max_upload_records"
body.name — Optional $ref: "#/definitions/logpush_name"
body.output_options — Optional $ref: "#/definitions/logpush_output_options"
body.ownership_challenge — Optional $ref: "#/definitions/logpush_ownership_challenge"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "dataset": "http_requests",
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "enabled": false,
    "filter": "{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}",
    "kind": "",
    "max_upload_bytes": 5000000,
    "max_upload_interval_seconds": 30,
    "max_upload_records": 1000,
    "name": "example.com",
    "output_options": {
      "CVE-2021-44228": false,
      "batch_prefix": "",
      "batch_suffix": "",
      "field_delimiter": ",",
      "field_names": [
        "RayID",
        "ClientIP",
        "EdgeStartTimestamp"
      ],
      "output_type": "ndjson",
      "record_delimiter": "",
      "record_prefix": "{",
      "record_suffix": "}\n",
      "sample_rate": 1,
      "timestamp_format": "unixnano"
    },
    "ownership_challenge": "00000000000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Logpush job — cloudflare.delete-zones-zone_id-logpush-jobs-job_id

Deletes a Logpush job.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.job_id — Required $ref: "#/definitions/logpush_id"
path.zone_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "job_id": 1,
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Logpush job details — cloudflare.get-zones-zone_id-logpush-jobs-job_id

Gets the details of a Logpush job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.job_id — Required $ref: "#/definitions/logpush_id"
path.zone_id — Required $ref: "#/definitions/logpush_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "job_id": 1,
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Logpush job — cloudflare.put-zones-zone_id-logpush-jobs-job_id

Updates a Logpush job.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.job_id — Required $ref: "#/definitions/logpush_id"
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Optional $ref: "#/definitions/logpush_destination_conf"
body.enabled — Optional $ref: "#/definitions/logpush_enabled"
body.filter — Optional $ref: "#/definitions/logpush_filter"
body.filter_attack_traffic — Optional $ref: "#/definitions/logpush_filter_attack_traffic"
body.frequency — Optional $ref: "#/definitions/logpush_frequency"
body.kind — Optional $ref: "#/definitions/logpush_kind"
body.logpull_options — Optional $ref: "#/definitions/logpush_logpull_options"
body.max_upload_bytes — Optional $ref: "#/definitions/logpush_max_upload_bytes"
body.max_upload_interval_seconds — Optional $ref: "#/definitions/logpush_max_upload_interval_seconds"
body.max_upload_records — Optional $ref: "#/definitions/logpush_max_upload_records"
body.name — Optional $ref: "#/definitions/logpush_name"
body.output_options — Optional $ref: "#/definitions/logpush_output_options"
body.ownership_challenge — Optional $ref: "#/definitions/logpush_ownership_challenge"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "job_id": 1,
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "enabled": false,
    "filter": "{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}",
    "kind": "",
    "max_upload_bytes": 5000000,
    "max_upload_interval_seconds": 30,
    "max_upload_records": 1000,
    "output_options": {
      "CVE-2021-44228": false,
      "batch_prefix": "",
      "batch_suffix": "",
      "field_delimiter": ",",
      "field_names": [
        "RayID",
        "ClientIP",
        "EdgeStartTimestamp"
      ],
      "output_type": "ndjson",
      "record_delimiter": "",
      "record_prefix": "{",
      "record_suffix": "}\n",
      "sample_rate": 1,
      "timestamp_format": "unixnano"
    },
    "ownership_challenge": "00000000000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get ownership challenge — cloudflare.post-zones-zone_id-logpush-ownership

Gets a new ownership challenge sent to your destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate ownership challenge — cloudflare.post-zones-zone_id-logpush-ownership-validate

Validates ownership challenge of the destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"
body.ownership_challenge — Required $ref: "#/definitions/logpush_ownership_challenge"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "ownership_challenge": "00000000000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate destination — cloudflare.post-zones-zone_id-logpush-validate-destination

Validates destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check destination exists — cloudflare.post-zones-zone_id-logpush-validate-destination-exists

Checks if there is an existing job with a destination.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.destination_conf — Required $ref: "#/definitions/logpush_destination_conf"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "destination_conf": "s3://mybucket/logs?region=us-west-2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate origin — cloudflare.post-zones-zone_id-logpush-validate-origin

Validates logpull origin with logpull_options.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logpush_identifier"
body object Required
body.logpull_options — Required $ref: "#/definitions/logpush_logpull_options"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get log retention flag — cloudflare.get-zones-zone_id-logs-control-retention-flag

Gets log retention flag for Logpull API.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logcontrol_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update log retention flag — cloudflare.post-zones-zone_id-logs-control-retention-flag

Updates log retention flag for Logpull API.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logcontrol_identifier"
body — Required $ref: "#/definitions/logcontrol_retention_flag"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get logs RayIDs — cloudflare.get-zones-zone_id-logs-rayids-ray_id

The /rayids api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logshare_zone_identifier"
path.ray_id — Required $ref: "#/definitions/logshare_ray_identifier"
query object Optional additionalProperties: false
query.fields — Optional $ref: "#/definitions/logshare_fields"
query.timestamps — Optional $ref: "#/definitions/logshare_timestamps"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "ray_id": "41ddf1740f67442d"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get logs received — cloudflare.get-zones-zone_id-logs-received

The /received api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare's central data center. start is inclusive, and end is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z, then start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z and so on; the overlap will be handled properly.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logshare_zone_identifier"
query object Required additionalProperties: false
query.start — Optional $ref: "#/definitions/logshare_start"
query.end — Required $ref: "#/definitions/logshare_end"
query.fields — Optional $ref: "#/definitions/logshare_fields"
query.sample — Optional $ref: "#/definitions/logshare_sample"
query.count — Optional $ref: "#/definitions/logshare_count"
query.timestamps — Optional $ref: "#/definitions/logshare_timestamps"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "end": "2018-05-20T10:01:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List fields — cloudflare.get-zones-zone_id-logs-received-fields

Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/logshare_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Managed Transforms — cloudflare.deletemanagedtransforms

Disables all Managed Transforms.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Managed Transforms — cloudflare.listmanagedtransforms

Fetches a list of all Managed Transforms.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Managed Transforms — cloudflare.updatemanagedtransforms

Updates the status of one or more Managed Transforms.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
body — Required $ref: "#/definitions/rulesets_ManagedTransformsPatch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get zone Media usage — cloudflare.usage-analytics-get-zone-media-usage

Retrieve Media usage analytics for a zone. This endpoint shares the same backend handler as the Stream usage endpoint and returns identical Stream metrics (streamMinutesViewed). The gateway resolves the zone to its owning account and rewrites this path to the shared usage handler.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Standard Cloudflare hex zone identifier. The API gateway resolves this to the owning account and translates it to an internal numeric ID before forwarding to the backend service. $ref: "#/definitions/usage-analytics_identifier"
query object Optional additionalProperties: false
query.metrics string Optional Comma-separated list of metrics to include in the response. Available metrics depend on the endpoint. Billing usage supports: streamMinutesViewed, rateLimitingRequestsAllowed, loadBalancingQueries, argoAcceleratedBytes, workersRequests, workersKVReads, imageResizingRequests, spectrumBytesTransferred, mediaUniqueTransformations. Stream/media usage supports: streamMinutesViewed.
query.since string Optional Start of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to 6 hours before the current time. format: "date-time"
query.until string Optional End of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to the current time. format: "date-time"
query.time_delta string Optional Time unit to aggregate usage observations into. Data retention is approximately 18 months. The effective number of data points returned depends on the time range and granularity selected. For example, requesting hourly granularity over 18 months could produce up to ~13,000 data points; use the limit parameter to cap results and be aware that responses may be truncated. enum: ["hour","day","week","month","quarter","year"]; default: "hour"
query.limit integer Optional Maximum number of data points to return. The actual number of results depends on the interaction between the time range (since/until) and time_delta granularity. Results are truncated to this limit without error if the time range produces more data points than the limit allows. default: 100; minimum: 1; maximum: 10000
query.filters string Optional Filter expressions to apply to the query. Format: field==value. Multiple filters can be combined.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get zone monetization eligibility — cloudflare.monetization-get-zone-eligibility

Returns the zone's latest stored monetization eligibility result.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Check zone monetization eligibility — cloudflare.monetization-check-zone-eligibility

Checks the zone for Monetization Gateway eligibility and enables its entitlement when the decision is approved.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all payment rules — cloudflare.monetization-delete-ruleset

Removes every Payment Required rule from the zone. Any rules the service does not own are preserved. Deleting a zone with no payment rules is a no-op. Returns the resulting (empty) rule collection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List payment rules — cloudflare.monetization-list-rules

Returns the currently deployed Payment Required rules for a zone. A zone with no Payment Required ruleset returns 404.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deploy payment ruleset — cloudflare.monetization-deploy-ruleset

Replaces the zone's Payment Required ruleset with the submitted desired state. Submit an empty rules array to clear all payment rules.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"
body — Required $ref: "#/definitions/monetization_monetization-ruleset-input"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  },
  "body": {
    "rules": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a payment rule — cloudflare.monetization-delete-rule

Removes a single Payment Required rule identified by its ID. Every other rule is preserved. Returns the resulting rule collection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"
path.rule_id — Required The unique ID of the payment rule. $ref: "#/definitions/monetization_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074",
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a payment rule — cloudflare.monetization-get-rule

Returns a single Payment Required rule identified by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"
path.rule_id — Required The unique ID of the payment rule. $ref: "#/definitions/monetization_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074",
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a payment rule — cloudflare.monetization-patch-rule

Applies a partial update to a single Payment Required rule. Only the fields present in the request body are changed; omitted fields keep their current values. Returns the full resulting rule collection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/monetization_zone-identifier"
path.rule_id — Required The unique ID of the payment rule. $ref: "#/definitions/monetization_identifier"
body — Required $ref: "#/definitions/monetization_monetization-rule-patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074",
    "rule_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete zone trace rules — cloudflare.zone.observability.tracing.rules.delete

Delete every sampling override from a zone's managed Cloudflare Traces ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Specify the zone ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

View zone trace rules — cloudflare.zone.observability.tracing.rules.get

Retrieve the ordered sampling overrides for a zone's managed Cloudflare Traces ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Specify the zone ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace zone trace rules — cloudflare.zone.observability.tracing.rules.update

Replace all sampling overrides in a zone's managed Cloudflare Traces ruleset. Rules are evaluated in the supplied order.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Specify the zone ID.
body object Required
body.rules array Required Trace rules in evaluation order. maxItems: 1000
body.rules[] object Optional additionalProperties: false
body.rules[].action string Required enum: ["set_trace_settings"]
body.rules[].action_parameters object Required additionalProperties: false
body.rules[].action_parameters.sampling_ratio number Required The ratio of requests sampled for tracing, from 0 to 1. minimum: 0; maximum: 1
body.rules[].description string Required maxLength: 1000
body.rules[].enabled boolean Required
body.rules[].expression string Required A Rules language expression that selects requests. minLength: 1; maxLength: 4096

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": {
    "rules": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset zone tracing settings — cloudflare.zone.observability.tracing.settings.delete

Reset the zone-level Cloudflare Traces settings to their defaults while preserving the sampling rules.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Specify the zone ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

View zone tracing settings — cloudflare.zone.observability.tracing.settings.get

Retrieve the zone-level Cloudflare Traces settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required Specify the zone ID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List origin cloud region mappings — cloudflare.origin-cloud-regions-v2-list

Returns all IP-to-cloud-region mappings configured for the zone with pagination support. Each mapping tells Cloudflare which cloud vendor and region hosts the origin at that IP, enabling the edge to route via the nearest Tiered Cache upper-tier co-located with that cloud provider. Returns an empty array when no mappings exist.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Number of items per page. default: 20; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch delete origin cloud region mappings — cloudflare.origin-cloud-regions-v2-batch-delete

Removes up to 100 IP-to-cloud-region mappings in a single request. Each IP is validated independently — successfully deleted items are returned in the succeeded array and IPs that could not be found or are invalid are returned in the failed array.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body array Required maxItems: 100
body[] string Optional Origin IP address to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Batch create or replace origin cloud region mappings — cloudflare.origin-cloud-regions-v2-batch-upsert

Upserts up to 100 IP-to-cloud-region mappings in a single request. Items in the request body are created or replaced; mappings not included in the request body are preserved unchanged (this is a merge operation, not a full collection replacement). Each item is validated independently — valid items are applied and invalid items are returned in the failed array. The vendor and region for every item are validated against the list from GET /zones/{zone_id}/origin/cloud_regions/supported_regions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body array Required maxItems: 100
body[] — Optional $ref: "#/definitions/cache-settings_origin_cloud_region_v2_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List supported cloud vendors and regions — cloudflare.origin-cloud-regions-v2-supported-regions

Returns the cloud vendors and regions that are valid values for origin cloud region mappings. Each region includes the Tiered Cache upper-tier colocation codes that will be used for cache routing when a mapping targeting that region is active. Requires the zone to have Tiered Cache enabled.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an origin cloud region mapping — cloudflare.origin-cloud-regions-v2-delete

Removes the cloud region mapping for a single origin IP address. The IP path parameter is normalized before lookup. Returns the deleted IP on success. Returns 404 if no mapping exists for the specified IP. When the last mapping for the zone is removed the underlying rule record is also deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
path.origin_ip string Required Origin IP address whose mapping should be deleted.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "origin_ip": "192.0.2.1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an origin cloud region mapping — cloudflare.origin-cloud-regions-v2-get

Returns the cloud region mapping for a single origin IP address. The IP path parameter is normalized before lookup (RFC 5952 for IPv6). Returns 404 if the zone has no mappings or if the specified IP has no mapping.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
path.origin_ip string Required Origin IP address to look up. IPv4 and IPv6 are supported.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "origin_ip": "192.0.2.1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or replace an origin cloud region mapping — cloudflare.origin-cloud-regions-v2-upsert

Creates a new IP-to-cloud-region mapping or replaces the existing mapping for the specified IP. PUT is idempotent — calling it repeatedly with the same body produces the same result. The IP path parameter is normalized to canonical form (RFC 5952 for IPv6) before storage. The vendor and region are validated against the list from GET /zones/{zone_id}/origin/cloud_regions/supported_regions. Returns 400 if the origin_ip in the body does not match the URL path parameter. Returns 403 (code 1164) when the zone has reached the limit of 3,500 IP mappings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
path.origin_ip string Required Origin IP address to create or replace.
body — Required $ref: "#/definitions/cache-settings_origin_cloud_region_v2_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "origin_ip": "192.0.2.1"
  },
  "body": {
    "origin_ip": "192.0.2.1",
    "vendor": "aws",
    "region": "us-east-1"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Certificates — cloudflare.zone-level-authenticated-origin-pulls-list-certificates

Lists all client certificates configured for zone-level authenticated origin pulls.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload Certificate — cloudflare.zone-level-authenticated-origin-pulls-upload-certificate

Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.certificate — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate-5"
body.private_key — Required $ref: "#/definitions/tls-certificates-and-hostnames_private_key-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Hostname Associations — cloudflare.per-hostname-authenticated-origin-pull-list-hostname-associations

List certificate ID - hostname associations for the given zone. Shows which hostnames are associated to which certificates for authenticated origin pulls.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of associations per page. default: 50; minimum: 1; maximum: 1000
query.status string Optional Filter associations by status. Use comma-separated values to filter by multiple statuses, or "all" to include every status. Defaults to "active" if not provided. enum: ["active","pending_deployment","pending_deletion","deleted","deployment_timed_out","deletion_timed_out","all"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable or Disable a Hostname for Client Authentication — cloudflare.per-hostname-authenticated-origin-pull-enable-or-disable-a-9a86acfd38

Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter enabled to invalidate the association.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.config — Required
body.config — Required allOf[1]; $ref: "#/definitions/tls-certificates-and-hostnames_config"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "config": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Certificates — cloudflare.per-hostname-authenticated-origin-pull-list-certificates

Lists all client certificates configured for per-hostname authenticated origin pulls on the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload a Hostname Client Certificate — cloudflare.per-hostname-authenticated-origin-pull-upload-a-hostname-c-0fd8e52701

Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.certificate — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate-6"
body.private_key — Required $ref: "#/definitions/tls-certificates-and-hostnames_private_key-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Hostname Client Certificate — cloudflare.per-hostname-authenticated-origin-pull-delete-hostname-cli-22f3b7c122

Removes a client certificate used for authenticated origin pulls on a specific hostname. Note: Before deleting the certificate, you must first invalidate the hostname for client authentication by sending a PUT request with enabled set to null. After invalidating the association, the certificate can be safely deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname_aop_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Hostname Client Certificate — cloudflare.per-hostname-authenticated-origin-pull-get-the-hostname-cl-9a143608ca

Get the certificate by ID to be used for client authentication on a hostname.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname_aop_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Hostname Status for Client Authentication — cloudflare.per-hostname-authenticated-origin-pull-get-the-hostname-st-5bc83da3fe

Retrieves the client certificate authentication status for a specific hostname, showing whether authenticated origin pulls are enabled.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hostname — Required $ref: "#/definitions/tls-certificates-and-hostnames_hostname-2"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hostname": "app.example.com",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Enablement Setting for Zone — cloudflare.zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone

Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set Enablement for Zone — cloudflare.zone-level-authenticated-origin-pulls-set-enablement-for-zone

Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.enabled — Required $ref: "#/definitions/tls-certificates-and-hostnames_enabled-4"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Certificate — cloudflare.zone-level-authenticated-origin-pulls-delete-certificate

Removes a client certificate used for zone-level authenticated origin pulls.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_zone_aop_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Certificate Details — cloudflare.zone-level-authenticated-origin-pulls-get-certificate-details

Retrieves details for a specific client certificate used in zone-level authenticated origin pulls.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_zone_aop_certificate_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get client-side security settings — cloudflare.page-shield-get-settings

Returns the client-side security product enablement status and reporting behaviors.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update client-side security settings — cloudflare.page-shield-update-settings

Updates client-side security enablement and reporting behaviors for the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
body object Required
body.enabled — Optional $ref: "#/definitions/client-side-security_enabled"
body.use_cloudflare_reporting_endpoint — Optional $ref: "#/definitions/client-side-security_use_cloudflare_reporting_endpoint"
body.use_connection_url_path — Optional $ref: "#/definitions/client-side-security_use_connection_url_path"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List detected connections — cloudflare.page-shield-list-connections

Lists outbound connections made by webpages in the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
query object Optional additionalProperties: false
query.exclude_urls string Optional Excludes connections whose URL contains one of the URL-encoded URLs separated by commas.
query.urls string Optional Includes connections whose URL contain one or more URL-encoded URLs separated by commas.
query.hosts string Optional Includes connections that match one or more URL-encoded hostnames separated by commas. Wildcards are supported at the start and end of each hostname to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match
query.page string Optional The current page number of the paginated results. We additionally support a special value "all". When "all" is used, the API will return all the connections with the applied filters in a single page. This feature is best-effort and it may only work for zones with a low number of connections
query.per_page number Optional The number of results per page. minimum: 1; maximum: 100
query.order_by string Optional The field used to sort returned connections. enum: ["first_seen_at","last_seen_at"]
query.direction string Optional The direction used to sort returned connections. enum: ["asc","desc"]
query.prioritize_malicious boolean Optional When true, malicious connections appear first in the returned connections.
query.exclude_cdn_cgi boolean Optional When true, excludes connections seen in a /cdn-cgi path from the returned connections. The default value is true.
query.status string Optional Filters the returned connections using a comma-separated list of connection statuses. Accepted values: active, infrequent, and inactive. The default value is active.
query.page_url string Optional Includes connections that match one or more page URLs (separated by commas) where they were last seen Wildcards are supported at the start and end of each page URL to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match
query.export string Optional Export the list of connections as a file, limited to 50000 entries. enum: ["csv"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a detected connection — cloudflare.page-shield-get-connection

Returns a webpage connection detected on the zone by connection ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
path.connection_id — Required $ref: "#/definitions/client-side-security_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connection_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List detected cookies — cloudflare.page-shield-list-cookies

Lists cookies detected on the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
query object Optional additionalProperties: false
query.hosts string Optional Includes cookies that match one or more URL-encoded hostnames separated by commas. Wildcards are supported at the start and end of each hostname to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match
query.page string Optional The current page number of the paginated results. We additionally support a special value "all". When "all" is used, the API will return all the cookies with the applied filters in a single page. This feature is best-effort and it may only work for zones with a low number of cookies
query.per_page number Optional The number of results per page. minimum: 1; maximum: 100
query.order_by string Optional The field used to sort returned cookies. enum: ["first_seen_at","last_seen_at"]
query.direction string Optional The direction used to sort returned cookies.' enum: ["asc","desc"]
query.page_url string Optional Includes connections that match one or more page URLs (separated by commas) where they were last seen Wildcards are supported at the start and end of each page URL to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match
query.export string Optional Export the list of cookies as a file, limited to 50000 entries. enum: ["csv"]
query.name string Optional Filters the returned cookies that match the specified name. Wildcards are supported at the start and end to support starts with, ends with and contains. e.g. session* maxLength: 1024
query.secure boolean Optional Filters the returned cookies that are set with Secure
query.http_only boolean Optional Filters the returned cookies that are set with HttpOnly
query.same_site string Optional Filters the returned cookies that match the specified same_site attribute enum: ["lax","strict","none"]
query.type string Optional Filters the returned cookies that match the specified type attribute enum: ["first_party","unknown"]
query.path string Optional Filters the returned cookies that match the specified path attribute maxLength: 1024
query.domain string Optional Filters the returned cookies that match the specified domain attribute maxLength: 1024

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List content security rules — cloudflare.page-shield-list-policies

Lists content security rules configured for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a content security rule — cloudflare.page-shield-create-policy

Creates a rule that applies a client-side security action when its filter expression matches.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
body — Required $ref: "#/definitions/client-side-security_policy"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "description": "Checkout page CSP policy",
    "action": "allow",
    "expression": "ends_with(http.request.uri.path, \"/checkout\")",
    "enabled": true,
    "value": "script-src 'none';"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a content security rule — cloudflare.page-shield-delete-policy

Permanently deletes a content security rule by ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
path.policy_id — Required $ref: "#/definitions/client-side-security_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a content security rule — cloudflare.page-shield-get-policy

Returns a content security rule by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
path.policy_id — Required $ref: "#/definitions/client-side-security_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a content security rule — cloudflare.page-shield-update-policy

Updates the description, action, expression, enabled state, and policy value for a content security rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
path.policy_id — Required $ref: "#/definitions/client-side-security_id"
body object Required
body.action — Optional $ref: "#/definitions/client-side-security_policy-action"
body.description — Optional $ref: "#/definitions/client-side-security_policy-description"
body.enabled — Optional $ref: "#/definitions/client-side-security_policy-enabled"
body.expression — Optional $ref: "#/definitions/client-side-security_policy-expression"
body.value — Optional $ref: "#/definitions/client-side-security_policy-value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "policy_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List detected scripts — cloudflare.page-shield-list-scripts

Lists scripts detected on webpages in the zone, with filtering and pagination.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
query object Optional additionalProperties: false
query.exclude_urls string Optional Excludes scripts whose URL contains one of the URL-encoded URLs separated by commas.
query.urls string Optional Includes scripts whose URL contain one or more URL-encoded URLs separated by commas.
query.hosts string Optional Includes scripts that match one or more URL-encoded hostnames separated by commas. Wildcards are supported at the start and end of each hostname to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match
query.page string Optional The current page number of the paginated results. We additionally support a special value "all". When "all" is used, the API will return all the scripts with the applied filters in a single page. This feature is best-effort and it may only work for zones with a low number of scripts
query.per_page number Optional The number of results per page. minimum: 1; maximum: 100
query.order_by string Optional The field used to sort returned scripts. enum: ["first_seen_at","last_seen_at"]
query.direction string Optional The direction used to sort returned scripts. enum: ["asc","desc"]
query.prioritize_malicious boolean Optional When true, malicious scripts appear first in the returned scripts.
query.exclude_cdn_cgi boolean Optional When true, excludes scripts seen in a /cdn-cgi path from the returned scripts. The default value is true. default: true
query.exclude_duplicates boolean Optional When true, excludes duplicate scripts. We consider a script duplicate of another if their javascript content matches and they share the same url host and zone hostname. In such case, we return the most recent script for the URL host and zone hostname combination. default: true
query.status string Optional Filters the returned scripts using a comma-separated list of scripts statuses. Accepted values: active, infrequent, and inactive. The default value is active.
query.page_url string Optional Includes scripts that match one or more page URLs (separated by commas) where they were last seen Wildcards are supported at the start and end of each page URL to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match
query.export string Optional Export the list of scripts as a file, limited to 50000 entries. enum: ["csv"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a detected script — cloudflare.page-shield-get-script

Returns a script detected on the zone by script ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/client-side-security_id"
path.script_id — Required $ref: "#/definitions/client-side-security_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "script_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Page Rules — cloudflare.page-rules-list-page-rules

Fetches Page Rules in a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zones_identifier-2"
query object Optional additionalProperties: false
query.order string Optional The field used to sort returned Page Rules. enum: ["status","priority"]; default: "priority"
query.direction string Optional The direction used to sort returned Page Rules. enum: ["asc","desc"]; default: "desc"
query.match string Optional When set to all, all the search requirements must match. When set to any, only one of the search requirements has to match. enum: ["any","all"]; default: "all"
query.status string Optional The status of the Page Rule. enum: ["active","disabled"]; default: "disabled"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Page Rule — cloudflare.page-rules-create-a-page-rule

Creates a new Page Rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zones_identifier-2"
body object Required
body.actions — Required $ref: "#/definitions/zones_actions"
body.priority — Optional $ref: "#/definitions/zones_priority"
body.status — Optional $ref: "#/definitions/zones_status"
body.targets — Required $ref: "#/definitions/zones_targets"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "targets": [
      {
        "constraint": {
          "operator": "matches",
          "value": "*example.com/images/*"
        },
        "target": "url"
      }
    ],
    "actions": [
      {
        "id": "browser_check",
        "value": "on"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Page Rule — cloudflare.page-rules-delete-a-page-rule

Deletes an existing Page Rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pagerule_id — Required $ref: "#/definitions/zones_identifier-2"
path.zone_id — Required $ref: "#/definitions/zones_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pagerule_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Page Rule — cloudflare.page-rules-get-a-page-rule

Fetches the details of a Page Rule.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pagerule_id — Required $ref: "#/definitions/zones_identifier-2"
path.zone_id — Required $ref: "#/definitions/zones_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pagerule_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a Page Rule — cloudflare.page-rules-edit-a-page-rule

Updates one or more fields of an existing Page Rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pagerule_id — Required $ref: "#/definitions/zones_identifier-2"
path.zone_id — Required $ref: "#/definitions/zones_identifier-2"
body object Required
body.actions — Optional $ref: "#/definitions/zones_actions"
body.priority — Optional $ref: "#/definitions/zones_priority"
body.status — Optional $ref: "#/definitions/zones_status"
body.targets — Optional $ref: "#/definitions/zones_targets"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pagerule_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Page Rule — cloudflare.page-rules-update-a-page-rule

Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pagerule_id — Required $ref: "#/definitions/zones_identifier-2"
path.zone_id — Required $ref: "#/definitions/zones_identifier-2"
body object Required
body.actions — Required $ref: "#/definitions/zones_actions"
body.priority — Optional $ref: "#/definitions/zones_priority"
body.status — Optional $ref: "#/definitions/zones_status"
body.targets — Required $ref: "#/definitions/zones_targets"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pagerule_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "targets": [
      {
        "constraint": {
          "operator": "matches",
          "value": "*example.com/images/*"
        },
        "target": "url"
      }
    ],
    "actions": [
      {
        "id": "browser_check",
        "value": "on"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-crawl zone eligibility — cloudflare.pay-per-crawl.getzonecanbeenabled

Gets whether pay-per-crawl can be enabled for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the pay-per-crawl config — cloudflare.pay-per-crawl.getconfig

Gets the pay-per-crawl config for a zone including the bot configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Changes pay-per-crawl config for a zone — cloudflare.pay-per-crawl.patchconfig

Changes the pay-per-crawl config for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id
body — Required $ref: "#/definitions/pay-per-crawl_DaricConfig"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-use zone eligibility — cloudflare.pay-per-crawl.getppuzonecanbeenabled

Gets whether pay-per-use can be enabled for a zone and the current zone-level grace period.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-use zone configuration — cloudflare.pay-per-crawl.getppuzoneconfiguration

Gets the pay-per-use configuration, zone-level grace period, and read-only non-billable classification timestamp for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update pay-per-use zone configuration — cloudflare.pay-per-crawl.patchppuzoneconfiguration

Enables or disables an existing pay-per-use zone configuration. Omitting enabled leaves the zone unchanged. Enabling a disabled billable zone requires completed publisher Stripe onboarding, while non-billable zones do not; an already-enabled zone is not affected by later Stripe status changes. Disabling starts a disabled period immediately while existing accepted licenses remain active until the start of the next UTC month; re-enabling before expiry clears the schedule and restores those licenses.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id
body — Required $ref: "#/definitions/pay-per-crawl_PPUZoneConfigurationUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List pay-per-use operators — cloudflare.pay-per-crawl.listppuoperators

Lists a paginated set of enabled pay-per-use operators with verified names, matching billing classification, and their prices for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id
query object Optional additionalProperties: false
query.page integer Optional Page number. default: 1; minimum: 1
query.per_page integer Optional Results per page. default: 100; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get pay-per-use usage statistics for a zone — cloudflare.pay-per-crawl.getppuzoneusagestats

Returns reported usage and the full gross value for one Pay Per Use zone over an explicit UTC range of at most 31 days. Usage from every snapshotted price is summed by buyer. Ranges up to and including 7 days use hourly data points; longer ranges use daily data points. Because source data is aggregated hourly, both requested bounds are rounded down to the selected UTC interval and the resolved bounds are returned in the response. The resolved range must contain at least one complete interval. Empty periods are omitted. Buyers and their data points are paginated, while totals cover every buyer in the range. Values are raw usage counts and USD microcents; total_price_usd_microcents is the full value before the publisher revenue share.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required zone id
query object Required additionalProperties: false
query.since string Required Requested inclusive beginning of the statistics range as an RFC3339 timestamp. Rounded down to the selected UTC interval. format: "date-time"
query.until string Required Requested exclusive end of the statistics range as an RFC3339 timestamp. Rounded down to the selected UTC interval. The requested duration from since cannot exceed 31 days. format: "date-time"
query.page integer Optional Page number. default: 1; minimum: 1
query.per_page integer Optional Results per page. default: 100; minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "query": {
    "since": "2026-01-01T00:00:00Z",
    "until": "2026-01-01T00:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zone Precursor Config — cloudflare.precursor-for-a-zone-get-config

Retrieve a zone's Precursor configuration: the detection mode, whether to show_interstitial, and the ordered list of rules.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Required additionalProperties: false
headers.Cloudflare-Version string Required Selects the split Precursor API schema. enum: ["1.0"]; default: "1.0"
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/precursor_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "headers": {
    "Cloudflare-Version": "1.0"
  },
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zone Precursor Config — cloudflare.precursor-for-a-zone-update-config

Updates the Precursor configuration for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Required additionalProperties: false
headers.Cloudflare-Version string Required Selects the split Precursor API schema. enum: ["1.0"]; default: "1.0"
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/precursor_identifier"
body — Required $ref: "#/definitions/precursor_precursor_config"

Full JSON Schema

Full JSON Schema

Example input

{
  "headers": {
    "Cloudflare-Version": "1.0"
  },
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "mode": "arm",
    "rules": [
      {
        "description": "Show an interstitial on the shop page",
        "enabled": true,
        "expression": "http.request.uri.path eq \"/shop\"",
        "show_interstitial": true
      }
    ],
    "show_interstitial": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge Cached Content — cloudflare.zone-purge

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.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required The zone ID. $ref: "#/definitions/cache-purge_identifier"
body — Required
body — Required anyOf[1]; $ref: "#/definitions/cache-purge_FlexPurgeByTags"
body — Required anyOf[2]; $ref: "#/definitions/cache-purge_FlexPurgeByHostnames"
body — Required anyOf[3]; $ref: "#/definitions/cache-purge_FlexPurgeByPrefixes"
body — Required anyOf[4]; $ref: "#/definitions/cache-purge_Everything"
body — Required anyOf[5]; $ref: "#/definitions/cache-purge_SingleFile"
body — Required anyOf[6]; $ref: "#/definitions/cache-purge_SingleFileWithUrlAndHeaders"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "tags": [
      "product-1234",
      "homepage"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List zone rulesets — cloudflare.listzonerulesets

Fetches all rulesets at the zone level.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
query object Optional additionalProperties: false
query.cursor — Optional $ref: "#/definitions/rulesets_Cursor"
query.per_page — Optional $ref: "#/definitions/rulesets_PerPage"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a zone ruleset — cloudflare.createzoneruleset

Creates a ruleset at the zone level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false
body — Required
body — Required allOf[1]; $ref: "#/definitions/rulesets_Ruleset"
body object Required allOf[2]
body.kind — Required allOf[2]; $ref: "#/definitions/rulesets_RulesetKind"
body.phase — Required allOf[2]; $ref: "#/definitions/rulesets_RulesetPhase"
body.rules — Optional allOf[2]; $ref: "#/definitions/rulesets_RequestRules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  },
  "body": {
    "name": "example",
    "kind": "root",
    "phase": "http_request_firewall_custom",
    "id": "2f2feab2026849078ba485f918791bdc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a zone entry point ruleset — cloudflare.getzoneentrypointruleset

Fetches the latest version of the zone entry point ruleset for a given phase.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_phase": "http_request_firewall_custom",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a zone entry point ruleset — cloudflare.updatezoneentrypointruleset

Updates a zone entry point ruleset, creating a new version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false
body — Required
body — Required allOf[1]; $ref: "#/definitions/rulesets_Ruleset"
body object Required allOf[2]
body.rules — Optional allOf[2]; $ref: "#/definitions/rulesets_RequestRules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_phase": "http_request_firewall_custom",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  },
  "body": {
    "id": "2f2feab2026849078ba485f918791bdc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a zone entry point ruleset's versions — cloudflare.listzoneentrypointrulesetversions

Fetches the versions of a zone entry point ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_phase": "http_request_firewall_custom",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a zone entry point ruleset version — cloudflare.getzoneentrypointrulesetversion

Fetches a specific version of a zone entry point ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_phase — Required $ref: "#/definitions/rulesets_RulesetPhase"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_version": "1",
    "ruleset_phase": "http_request_firewall_custom",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a zone ruleset — cloudflare.deletezoneruleset

Deletes all versions of an existing zone ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a zone ruleset — cloudflare.getzoneruleset

Fetches the latest version of a zone ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a zone ruleset — cloudflare.updatezoneruleset

Updates a zone ruleset, creating a new version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false
body — Required
body — Required allOf[1]; $ref: "#/definitions/rulesets_Ruleset"
body object Required allOf[2]
body.kind — Optional allOf[2]; $ref: "#/definitions/rulesets_RulesetKind"
body.phase — Optional allOf[2]; $ref: "#/definitions/rulesets_RulesetPhase"
body.rules — Optional allOf[2]; $ref: "#/definitions/rulesets_RequestRules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  },
  "body": {
    "id": "2f2feab2026849078ba485f918791bdc"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a zone ruleset rule — cloudflare.deletezonerulesetrule

Deletes an existing rule from a zone ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/rulesets_RuleId"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "3a03d665bac047339bb530ecb439a90d",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a zone ruleset's versions — cloudflare.listzonerulesetversions

Fetches the versions of a zone ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a zone ruleset version — cloudflare.deletezonerulesetversion

Deletes an existing version of a zone ruleset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
query object Optional additionalProperties: false
query.dry_run boolean Optional 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. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_version": "1",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a zone ruleset version — cloudflare.getzonerulesetversion

Fetches a specific version of a zone ruleset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ruleset_version": "1",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a zone ruleset version's rules by tag — cloudflare.listzonerulesetversionrulesbytag

Fetches the rules of a managed zone ruleset version for a given tag.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_tag — Required $ref: "#/definitions/rulesets_RuleCategory"
path.ruleset_version — Required $ref: "#/definitions/rulesets_RulesetVersion"
path.ruleset_id — Required $ref: "#/definitions/rulesets_RulesetId"
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_tag": "directory-traversal",
    "ruleset_version": "1",
    "ruleset_id": "2f2feab2026849078ba485f918791bdc",
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all uploaded schemas — cloudflare.schema-validation-list-schemas-paginated

Lists all OpenAPI schemas uploaded to API Security.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.omit_source boolean Optional Omit the source-files of schemas and only retrieve their meta-data. default: false
query.validation_enabled boolean Optional Filter for enabled schemas

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Upload a schema — cloudflare.schema-validation-create-schema

Uploads an OpenAPI schema that defines expected request formats for API operations.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body object Required
body.kind string Required The kind of the schema enum: ["openapi_v3"]
body.name string Required A human-readable name for the schema
body.source string Required The raw schema, e.g., the OpenAPI schema, either as JSON or YAML
body.validation_enabled boolean Required An indicator if this schema is enabled

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "petstore schema",
    "kind": "openapi_v3",
    "source": "<schema file contents>",
    "validation_enabled": false
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List hosts covered by uploaded schemas — cloudflare.schema-validation-list-schema-hosts

Lists all unique hosts found in uploaded OpenAPI schemas for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get global schema validation settings — cloudflare.schema-validation-get-settings

Retrieves the current global schema validation settings for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit global schema validation settings — cloudflare.schema-validation-edit-settings

Partially updates global schema validation settings for a zone using PATCH semantics.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body — Required $ref: "#/definitions/api-shield_global_setting_change_base"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List per-operation schema validation settings — cloudflare.schema-validation-list-per-operation-settings

Lists per-operation schema validation settings configured for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk edit per-operation schema validation settings — cloudflare.schema-validation-bulk-edit-per-operation-settings

Updates schema validation settings for multiple API operations in a single request. Efficient for applying consistent validation rules across endpoints.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body object Required additionalProperties: {"description":"Operation ID to mitigation action mappings","properties":{"mitigation_action":{"description":"Mitigation actions are as follows:\n* `log` - log request when request does not conform to schema * `block` - deny access to the site when request does not conform to schema * `none` - skip running schema validation * null - clears any existing per-operation setting\n","type":["string","null"],"enum":["none","log","block",null],"examples":["block"]}},"type":"object"}

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "3818d821-5901-4147-a474-f5f5aec1d54e": {
      "mitigation_action": "log"
    },
    "b17c8043-99a0-4202-b7d9-8f7cdbee02cd": {
      "mitigation_action": "block"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete per-operation schema validation setting — cloudflare.schema-validation-delete-per-operation-setting

Removes custom schema validation settings for a specific API operation, reverting to zone-level defaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.operation_id — Required Identifier for the operation $ref: "#/definitions/api-shield_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get per-operation schema validation setting — cloudflare.schema-validation-get-per-operation-setting

Retrieves the schema validation settings configured for a specific API operation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.operation_id — Required Identifier for the operation $ref: "#/definitions/api-shield_uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Force AXFR — cloudflare.secondary-dns---secondary-zone--force-axfr

Sends AXFR zone transfer request to primary nameserver(s).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Secondary Zone Configuration — cloudflare.secondary-dns---secondary-zone--delete-secondary-zone-configuration

Delete secondary zone configuration for incoming zone transfers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Secondary Zone Configuration Details — cloudflare.secondary-dns---secondary-zone--secondary-zone-configuration-details

Get secondary zone configuration for incoming zone transfers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Secondary Zone Configuration — cloudflare.secondary-dns---secondary-zone--create-secondary-zone-configuration

Create secondary zone configuration for incoming zone transfers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"
body — Required $ref: "#/definitions/secondary-dns_dns-secondary-secondary-zone"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  },
  "body": {
    "id": "269d8f4853475ca241c4e730be286b20",
    "name": "www.example.com.",
    "peers": [
      "23ff594956f20c2a721606e94745a8aa",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "auto_refresh_seconds": 86400
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Secondary Zone Configuration — cloudflare.secondary-dns---secondary-zone--update-secondary-zone-configuration

Update secondary zone configuration for incoming zone transfers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"
body — Required $ref: "#/definitions/secondary-dns_dns-secondary-secondary-zone"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  },
  "body": {
    "id": "269d8f4853475ca241c4e730be286b20",
    "name": "www.example.com.",
    "peers": [
      "23ff594956f20c2a721606e94745a8aa",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "auto_refresh_seconds": 86400
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Primary Zone Configuration — cloudflare.secondary-dns---primary-zone--delete-primary-zone-configuration

Delete primary zone configuration for outgoing zone transfers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Primary Zone Configuration Details — cloudflare.secondary-dns---primary-zone--primary-zone-configuration-details

Get primary zone configuration for outgoing zone transfers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Primary Zone Configuration — cloudflare.secondary-dns---primary-zone--create-primary-zone-configuration

Create primary zone configuration for outgoing zone transfers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"
body — Required $ref: "#/definitions/secondary-dns_single_request_outgoing"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  },
  "body": {
    "id": "269d8f4853475ca241c4e730be286b20",
    "name": "www.example.com.",
    "peers": [
      "23ff594956f20c2a721606e94745a8aa",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Primary Zone Configuration — cloudflare.secondary-dns---primary-zone--update-primary-zone-configuration

Update primary zone configuration for outgoing zone transfers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"
body — Required $ref: "#/definitions/secondary-dns_single_request_outgoing"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  },
  "body": {
    "id": "269d8f4853475ca241c4e730be286b20",
    "name": "www.example.com.",
    "peers": [
      "23ff594956f20c2a721606e94745a8aa",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable Outgoing Zone Transfers — cloudflare.secondary-dns---primary-zone--disable-outgoing-zone-transfers

Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable Outgoing Zone Transfers — cloudflare.secondary-dns---primary-zone--enable-outgoing-zone-transfers

Enable outgoing zone transfers for primary zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Force DNS NOTIFY — cloudflare.secondary-dns---primary-zone--force-dns-notify

Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Outgoing Zone Transfer Status — cloudflare.secondary-dns---primary-zone--get-outgoing-zone-transfer-status

Get primary zone transfer status.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/secondary-dns_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "269d8f4853475ca241c4e730be286b20"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Zone Security Center Insights — cloudflare.get-zone-security-center-insights

Lists Security Center insights for a specific zone, showing zone-level security findings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"
query.page — Optional default: 1
query.page — Optional allOf[1]; $ref: "#/definitions/security-center_page"
query.per_page — Optional default: 25
query.per_page — Optional allOf[1]; $ref: "#/definitions/security-center_perPage"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Zone Audit Log — cloudflare.get-zone-security-center-audit-log

Lists audit log entries for all Security Center insights in a specific zone, showing changes to insight status and classification.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.per_page integer Optional Number of results per page. default: 25; minimum: 1; maximum: 1000
query.cursor string Optional Opaque cursor for pagination. Use the cursor value from result_info of the previous response.
query.field_changed string Optional Filter by the field that was changed. enum: ["status","user_classification"]
query.changed_by string Optional Filter by the actor that made the change.
query.since string Optional Filter entries changed at or after this timestamp (RFC 3339). format: "date-time"
query.before string Optional Filter entries changed before this timestamp (RFC 3339). format: "date-time"
query.order string Optional Sort order for results. Use 'asc' for oldest first or 'desc' for newest first. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Zone Security Center Insight Counts by Class — cloudflare.get-zone-security-center-insight-counts-by-class

Retrieves zone-specific Security Center insight counts aggregated by classification class.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves a Partner Zone Security Center Insight Count — cloudflare.get-zone-security-center-partner-insight-count

Retrieves the uncapped count of active, non-dismissed, unclassified RiskRecon insights for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
query object Required additionalProperties: false
query.source string Required enum: ["riskrecon"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "source": "riskrecon"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Recent Zone Scans — cloudflare.get-security-center-zone-scans

Returns the most recent on-demand scans for a specific zone, up to a maximum of 5. Each scan includes its ID, start time, and current status. Results include both zone-specific scans and account-wide scans (which cover all zones). Also returns quota information showing how many scans have been used and how many remain in the current 24-hour window.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start On-Demand Zone Scan — cloudflare.start-security-center-zone-scan

Initiates an on-demand security scan for a specific zone. Rate limited to 5 scans per account per 24-hour window (shared with account-level scans).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
body — Required $ref: "#/definitions/security-center_newScanRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "issue_type": "compliance_violation"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Zone Security Center Insight Counts by Severity — cloudflare.get-zone-security-center-insight-counts-by-severity

Retrieves zone-specific Security Center insight counts aggregated by severity level.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Zone Security Center Insight Counts by Type — cloudflare.get-zone-security-center-insight-counts-by-type

Retrieves zone-specific Security Center insight counts aggregated by insight type.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
query object Optional additionalProperties: false
query.dismissed — Optional $ref: "#/definitions/security-center_dismissed"
query.issue_class — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type — Optional $ref: "#/definitions/security-center_issueTypes"
query.product — Optional $ref: "#/definitions/security-center_products"
query.source — Optional $ref: "#/definitions/security-center_sources"
query.severity — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject — Optional $ref: "#/definitions/security-center_subjects"
query.issue_class~neq — Optional $ref: "#/definitions/security-center_issueClasses"
query.issue_type~neq — Optional $ref: "#/definitions/security-center_issueTypes"
query.product~neq — Optional $ref: "#/definitions/security-center_products"
query.severity~neq — Optional $ref: "#/definitions/security-center_severityQueryParam"
query.subject~neq — Optional $ref: "#/definitions/security-center_subjects"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Zone Issue Audit Log — cloudflare.get-zone-security-center-issue-audit-log

Lists audit log entries for a specific Security Center insight within a zone, showing changes to its status and classification over time.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
path.issue_id string Required
query object Optional additionalProperties: false
query.per_page integer Optional Number of results per page. default: 25; minimum: 1; maximum: 1000
query.cursor string Optional Opaque cursor for pagination. Use the cursor value from result_info of the previous response.
query.field_changed string Optional Filter by the field that was changed. enum: ["status","user_classification"]
query.changed_by string Optional Filter by the actor that made the change.
query.since string Optional Filter entries changed at or after this timestamp (RFC 3339). format: "date-time"
query.before string Optional Filter entries changed before this timestamp (RFC 3339). format: "date-time"
query.order string Optional Sort order for results. Use 'asc' for oldest first or 'desc' for newest first. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "issue_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates Zone Security Center Insight Classification — cloudflare.update-zone-security-center-insight-classification

Updates the user classification for a zone-specific Security Center insight. Valid values are 'false_positive' or 'accept_risk'. To reset, set classification to null. Cannot change directly between classification values - must reset to null first.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
path.issue_id string Required
body — Required $ref: "#/definitions/security-center_userClassificationUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "issue_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Archives Zone Security Center Insight — cloudflare.archive-zone-security-center-insight

Archives a zone-specific Security Center insight, removing it from the active zone insights while preserving historical data.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
path.issue_id string Required
body object Required
body.dismiss boolean Optional default: true

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "issue_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lists Partner-Discovered Shadow Hosts for a Zone — cloudflare.get-zone-security-center-partner-shadow-hosts

Lists partner-discovered hosts beneath the zone that are not in the account.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
path.partner string Required The partner integration identifier. enum: ["riskrecon"]
query object Optional additionalProperties: false
query.cursor string Optional Opaque cursor from the previous response's result_info.cursor. Omit for the first page.
query.per_page integer Optional Number of premium partner asset results per page. Values other than 1 must be a multiple of 5. default: 25; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "partner": "riskrecon"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deletes security.txt — cloudflare.delete-security-txt

Removes the security.txt file configuration for a zone. The /.well-known/security.txt endpoint will no longer be served.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves security.txt — cloudflare.get-security-txt

Retrieves the current security.txt file configuration for a zone, used for security vulnerability reporting.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates security.txt — cloudflare.update-security-txt

Updates the security.txt file configuration for a zone, which provides security researchers with vulnerability reporting information.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/security-center_identifier"
body — Required $ref: "#/definitions/security-center_securityTxt"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete aegis setting — cloudflare.zone-cache-settings-delete-aegis-setting

Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get aegis setting — cloudflare.zone-cache-settings-get-aegis-setting

Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change aegis setting — cloudflare.zone-cache-settings-change-aegis-setting

Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_aegis_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Auto-Origin TLS KEX enrollment status for the given zone — cloudflare.ssl-detector-auto-origin-tls-kex-get-enrollment

When enabled, Cloudflare automatically selects the preferred TLS key-exchange algorithm to use when establishing the TLS connection to the zone's origin, picking from the algorithms permitted by the zone's origin_tls_compliance_modes setting. When disabled, the default key-exchange ordering is used.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Auto-Origin TLS KEX enrollment status for the given zone — cloudflare.ssl-detector-auto-origin-tls-kex-patch-enrollment

Enable or disable Auto-Origin TLS KEX selection for the zone by sending {"enabled": true} or {"enabled": false}. When enabled, Cloudflare runs a periodic scan of the zone's origins to determine the preferred key-exchange algorithm and writes that preference to the edge so it is sent first in the TLS ClientHello to the origin.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache_identifier"
body — Required $ref: "#/definitions/cache_auto_origin_tls_kex_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": true
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Automatic Platform Optimization setting — cloudflare.zone-settings-get-automatic-platform-optimization-setting

Automatic Platform Optimization (APO) for WordPress is a performance feature that serves your WordPress site from Cloudflare's edge network, reducing load times for visitors. Refer to the APO documentation for more information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Automatic Platform Optimization setting — cloudflare.zone-settings-change-automatic-platform-optimization-setting

Automatic Platform Optimization (APO) for WordPress is a performance feature that serves your WordPress site from Cloudflare's edge network, reducing load times for visitors. Refer to the APO documentation for more information.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_automatic_platform_optimization_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Binary AST setting — cloudflare.zone-settings-get-binary-ast-setting

Binary AST is a new binary encoding for JavaScript that enables faster parsing of scripts. When enabled, Cloudflare will serve a binary-encoded version of JavaScript to compatible browsers.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Binary AST setting — cloudflare.zone-settings-change-binary-ast-setting

Binary AST is a new binary encoding for JavaScript that enables faster parsing of scripts. When enabled, Cloudflare will serve a binary-encoded version of JavaScript to compatible browsers.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_binary_ast_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get CSAM Scanner setting — cloudflare.csam-scanner-get-setting

Retrieve the current CSAM Scanner configuration for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier for the zone. $ref: "#/definitions/csam-config-service_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update CSAM Scanner setting — cloudflare.csam-scanner-update-setting

Update the CSAM Scanner configuration for a zone. Allows enabling or disabling CSAM scanning, updating the notification email, and configuring scanning sources.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier for the zone. $ref: "#/definitions/csam-config-service_zone_identifier"
body — Required $ref: "#/definitions/csam-config-service_csam_scanner_third_party_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cloudflare Fonts setting — cloudflare.zone-settings-get-fonts-setting

Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Cloudflare Fonts setting — cloudflare.zone-settings-change-fonts-setting

Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_cloudflare_fonts_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Google Tag Gateway configuration — cloudflare.zone-settings-get-google-tag-gateway-config

Gets the Google Tag Gateway configuration for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/google-tag-gateway_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Google Tag Gateway configuration — cloudflare.zone-settings-change-google-tag-gateway-config

Updates the Google Tag Gateway configuration for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/google-tag-gateway_identifier"
body — Required $ref: "#/definitions/google-tag-gateway_google-tag-gateway-config"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "enabled": true,
    "endpoint": "/metrics",
    "hideOriginalIp": true,
    "measurementId": "GTM-P2F3N47Q"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get HTTP/2 Prioritization setting — cloudflare.zone-settings-get-h2-prioritization-setting

HTTP/2 Prioritization controls the order in which assets are delivered to browsers. Cloudflare's HTTP/2 Prioritization overrides the default browser prioritization order, improving the loading performance of web pages.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change HTTP/2 Prioritization setting — cloudflare.zone-settings-change-h2-prioritization-setting

HTTP/2 Prioritization controls the order in which assets are delivered to browsers. Cloudflare's HTTP/2 Prioritization overrides the default browser prioritization order, improving the loading performance of web pages.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_h2_prioritization_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Image Transformations setting — cloudflare.zone-settings-get-image-resizing-setting

Gets the Image Transformations setting for a zone. Accepted values are off, on, open, and latest.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Image Transformations setting — cloudflare.zone-settings-change-image-resizing-setting

Sets the Image Transformations setting for a zone. Accepted values are off, on, open, and latest.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_image_resizing_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get NEL setting — cloudflare.nel-settings-get

Fetches the Network Error Logging (NEL) setting for a zone. NEL allows browsers to report network errors to a configured endpoint. The setting is enabled by default for free and pro zones, and disabled by default for business and enterprise zones unless the NEL product feature is enabled.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier of the zone. $ref: "#/definitions/nel-config_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit NEL setting — cloudflare.nel-settings-edit

Updates the Network Error Logging (NEL) setting for a zone. Requires the NEL product feature to be enabled for the zone. The setting controls whether browsers report network errors to Cloudflare's NEL endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Identifier of the zone. $ref: "#/definitions/nel-config_zone_identifier"
body — Required $ref: "#/definitions/nel-config_nel_setting_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": {
      "enabled": true
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Origin H2 Max Streams Setting — cloudflare.zone-cache-settings-get-origin-h2-max-streams-setting

Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is 100 for all plan types except Enterprise where it is 1. 1 means that H2 multiplexing is disabled.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Origin H2 Max Streams Setting — cloudflare.zone-cache-settings-change-origin-h2-max-streams-setting

Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is 100 for all plan types except Enterprise where it is 1. 1 means that H2 multiplexing is disabled.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_origin_h2_max_streams_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": 50
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Origin Max HTTP Version Setting — cloudflare.zone-cache-settings-get-origin-max-http-version-setting

Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to Enable HTTP/2 to Origin, for more information.). The default value is "2" for all plan types except Enterprise where it is "1".

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Origin Max HTTP Version Setting — cloudflare.zone-cache-settings-change-origin-max-http-version-setting

Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to Enable HTTP/2 to Origin, for more information.). The default value is "2" for all plan types except Enterprise where it is "1".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_origin_max_http_version_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "2"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-delete-origin-tls-compliance-modes-setting

Delete the Origin TLS Compliance Modes setting for the zone, removing any configured compliance constraint. After deletion, Cloudflare's default behavior applies (no compliance filtering of the key-exchange algorithm list sent to the origin).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-get-origin-tls-compliance-modes-setting

Origin TLS Compliance Modes constrains the set of TLS key-exchange algorithms Cloudflare may use when establishing the TLS connection to the zone's origin. The value is a list of named compliance modes (currently fips and pqh). Multiple modes are combined as the intersection of their permitted algorithm lists. An empty list (or no rule configured) means no compliance constraint is applied.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-change-origin-tls-compliance-modes-setting

Update the set of TLS compliance modes for the zone. PATCH performs a full replace of the modes list, not a merge — the request body is treated as the complete new list, and any modes not present in it are removed. (To remove a single mode from an existing configuration, send the updated list without it.) The request body must be of the form {"value": ["fips", "pqh"]}. Currently supported modes are fips and pqh; an empty list clears the constraint. Future modes (e.g. cnsa2) may be added; clients should treat unknown values as opaque strings. Invalid mode values are rejected with a 4xx response.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_origin_tls_compliance_modes_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": [
      "fips",
      "pqh"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Origin TLS Compliance Modes setting — cloudflare.zone-cache-settings-replace-origin-tls-compliance-modes-setting

Replace the entire set of TLS compliance modes for the zone with the list provided in the request body. PUT performs a full replace, not a merge — any modes not present in the request body are removed. The request body must be of the form {"value": ["fips", "pqh"]}. Currently supported modes are fips and pqh; an empty list clears the constraint. Future modes (e.g. cnsa2) may be added; clients should treat unknown values as opaque strings. Invalid mode values are rejected with a 4xx response.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache-settings_identifier"
body object Required
body.value — Required $ref: "#/definitions/cache-settings_origin_tls_compliance_modes_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": [
      "fips",
      "pqh"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get RUM status for a zone — cloudflare.web-analytics-get-rum-status

Retrieves RUM status for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rum_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Toggle RUM on/off for a zone — cloudflare.web-analytics-toggle-rum

Toggles RUM on/off for an existing zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rum_identifier"
body — Required $ref: "#/definitions/rum_toggle-rum-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cloudflare Speed Brain setting — cloudflare.zone-settings-get-speed-brain-setting

Speed Brain lets compatible browsers speculate on content which can be prefetched or preloaded, making website navigation faster. Refer to the Cloudflare Speed Brain documentation for more information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Cloudflare Speed Brain setting — cloudflare.zone-settings-change-speed-brain-setting

Speed Brain lets compatible browsers speculate on content which can be prefetched or preloaded, making website navigation faster. Refer to the Cloudflare Speed Brain documentation for more information.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value string Required Whether the feature is enabled or disabled. enum: ["on","off"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "on"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Automatic SSL/TLS enrollment status for the given zone — cloudflare.ssl-detector-automatic-mode-get-enrollment

If the system is enabled, the response will include next_scheduled_scan, representing the next time this zone will be scanned and the zone's ssl/tls encryption mode is potentially upgraded by the system. If the system is disabled, next_scheduled_scan will not be present in the response body.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Automatic SSL/TLS Enrollment status for given zone — cloudflare.ssl-detector-automatic-mode-patch-enrollment

The automatic system is enabled when this endpoint is hit with value in the request body is set to "auto", and disabled when the request body value is set to "custom".

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/cache_identifier"
body — Required $ref: "#/definitions/cache_schemas_patch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "auto"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Image Transformations Allowed Origins setting — cloudflare.zone-settings-get-transformations-allowed-origins-setting

Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network to requests originating from specified domains. Refer to the Image Transformations and Video Transformations documentation for more information.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Image Transformations Allowed Origins setting — cloudflare.zone-settings-change-transformations-allowed-origins-setting

Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network to requests originating from specified domains. Refer to the Image Transformations and Video Transformations documentation for more information.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_transformations_allowed_origins_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "example.com,cdn.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Image Transformations C2PA setting — cloudflare.zone-settings-get-transformations-c2pa-setting

C2PA (Coalition for Content Provenance and Authenticity) signing adds cryptographic metadata to images processed through Cloudflare Image Transformations, enabling verification of image authenticity and provenance.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Image Transformations C2PA setting — cloudflare.zone-settings-change-transformations-c2pa-setting

C2PA (Coalition for Content Provenance and Authenticity) signing adds cryptographic metadata to images processed through Cloudflare Image Transformations, enabling verification of image authenticity and provenance.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_transformations_c2pa_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": "off"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Transformations configuration — cloudflare.zone-settings-get-transformations-config

Returns the combined Transformations configuration for a zone, including the transformations toggle, allowed origins, and C2PA signing settings in a single response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change Transformations configuration — cloudflare.zone-settings-change-transformations-config

Updates one or more fields of the combined Transformations configuration for a zone. Omitted fields are left unchanged. The response always returns the full current state of all three sub-settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/speed_identifier"
body object Required
body.value — Required $ref: "#/definitions/speed_transformations_config_value"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "value": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zaraz configuration — cloudflare.get-zones-zone_identifier-zaraz-config

Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get default Zaraz configuration — cloudflare.get-zones-zone_identifier-zaraz-default

Gets default Zaraz configuration for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export Zaraz configuration — cloudflare.get-zones-zone_identifier-zaraz-export

Exports full current published Zaraz configuration for a zone, secret variables included.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Zaraz historical configuration records — cloudflare.get-zones-zone_identifier-zaraz-history

Lists a history of published Zaraz configuration records for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"
query object Optional additionalProperties: false
query.offset integer Optional Ordinal number to start listing the results with. Default value is 0. minimum: 0
query.limit integer Optional Maximum amount of results to list. Default value is 10. minimum: 1
query.sortField string Optional The field to sort by. Default is updated_at. enum: ["id","user_id","description","created_at","updated_at"]
query.sortOrder string Optional Sorting order. Default is DESC. enum: ["DESC","ASC"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore Zaraz historical configuration by ID — cloudflare.put-zones-zone_identifier-zaraz-history

Restores a historical published Zaraz configuration by ID for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"
body integer Required ID of the Zaraz configuration to restore. minimum: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": 12345
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zaraz historical configurations by ID(s) — cloudflare.get-zones-zone_identifier-zaraz-config-history

Gets a history of published Zaraz configurations by ID(s) for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"
query object Required additionalProperties: false
query.ids array Required Comma separated list of Zaraz configuration IDs.
query.ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "ids": [
      12345,
      23456
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Publish Zaraz preview configuration — cloudflare.post-zones-zone_identifier-zaraz-publish

Publish current Zaraz preview configuration for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"
body string Optional Zaraz configuration description.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Zaraz workflow — cloudflare.get-zones-zone_identifier-zaraz-workflow

Gets Zaraz workflow for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zaraz workflow — cloudflare.put-zones-zone_identifier-zaraz-workflow

Updates Zaraz workflow for a zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zaraz_identifier"
body — Required $ref: "#/definitions/zaraz_zaraz-workflow"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": "realtime"
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get zone setting — cloudflare.zone-settings-get-single-setting

Fetch a single zone setting by name

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/zones_identifier"
path.setting_id — Required $ref: "#/definitions/zones_setting_name"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "setting_id": "always_online"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Smart Shield Settings — cloudflare.smart-shield-get-settings

Retrieve Smart Shield Settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Smart Shield Settings — cloudflare.smart-shield-patch-settings

Set Smart Shield Settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"
body — Required $ref: "#/definitions/smartshield_smart_shield_settings_patch_body"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "smart_tiered_cache": {
      "value": "on"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Cache Reserve Clear — cloudflare.smart-shield-settings-get-cache-reserve-clear

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start Cache Reserve Clear — cloudflare.smart-shield-settings-start-cache-reserve-clear

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Health Checks — cloudflare.smart-shield-list-health-checks

List configured health checks.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. Must be a multiple of 5. default: 25; minimum: 5; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Health Check — cloudflare.smart-shield-create-health-check

Create a new health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"
body — Required $ref: "#/definitions/smartshield_query_healthcheck"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "server-1",
    "address": "www.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Health Check — cloudflare.smart-shield-delete-health-check

Delete a health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/smartshield_identifier"
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Health Check Details — cloudflare.smart-shield-health-check-details

Fetch a single configured health check.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/smartshield_identifier"
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Health Check — cloudflare.smart-shield-patch-health-check

Patch a configured health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/smartshield_identifier"
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"
body — Required $ref: "#/definitions/smartshield_query_healthcheck"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "server-1",
    "address": "www.example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Health Check — cloudflare.smart-shield-update-health-check

Update a configured health check.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.healthcheck_id — Required $ref: "#/definitions/smartshield_identifier"
path.zone_id — Required $ref: "#/definitions/smartshield_identifier"
body — Required $ref: "#/definitions/smartshield_single_hc_response"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "healthcheck_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "success": true,
    "errors": [],
    "messages": [],
    "result": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List zone snippets — cloudflare.listzonesnippets

Fetches all snippets belonging to the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/snippets_ZoneId"
query object Optional additionalProperties: false
query.page — Optional $ref: "#/definitions/snippets_Page"
query.per_page — Optional $ref: "#/definitions/snippets_PerPage"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete zone snippet rules — cloudflare.deletezonesnippetrules

Deletes all snippet rules belonging to the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/snippets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List zone snippet rules — cloudflare.listzonesnippetrules

Fetches all snippet rules belonging to the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/snippets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update zone snippet rules — cloudflare.updatezonesnippetrules

Updates all snippet rules belonging to the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/snippets_ZoneId"
body object Required Define a snippet rules object.
body.rules — Required $ref: "#/definitions/snippets_SnippetRules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  },
  "body": {
    "rules": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a zone snippet — cloudflare.deletezonesnippet

Deletes a snippet belonging to the zone. Returns a 4XX response if the zone or snippet no longer exists.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/snippets_ZoneId"
path.snippet_name — Required $ref: "#/definitions/snippets_SnippetName"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074",
    "snippet_name": "my_snippet"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a zone snippet — cloudflare.getzonesnippet

Fetches a snippet belonging to the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/snippets_ZoneId"
path.snippet_name — Required $ref: "#/definitions/snippets_SnippetName"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074",
    "snippet_name": "my_snippet"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get current aggregated analytics — cloudflare.spectrum-aggregate-analytics-get-current-aggregated-analytics

Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/spectrum-analytics_identifier"
query object Optional additionalProperties: false
query.appID — Optional $ref: "#/definitions/spectrum-analytics_app_id_param"
query.colo_name string Optional Co-location identifier. maxLength: 3

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get analytics by time — cloudflare.spectrum-analytics---by-time--get-analytics-by-time

Retrieves a list of aggregate metrics grouped by time interval.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/spectrum-analytics_identifier"
query object Required additionalProperties: false
query.dimensions — Optional $ref: "#/definitions/spectrum-analytics_dimensions"
query.sort — Optional $ref: "#/definitions/spectrum-analytics_sort"
query.until — Optional $ref: "#/definitions/spectrum-analytics_until"
query.metrics — Optional $ref: "#/definitions/spectrum-analytics_metrics"
query.filters — Optional $ref: "#/definitions/spectrum-analytics_filters"
query.since — Optional $ref: "#/definitions/spectrum-analytics_since"
query.time_delta string Required Used to select time series resolution. enum: ["year","quarter","month","week","day","hour","dekaminute","minute"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "time_delta": "minute"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get analytics summary — cloudflare.spectrum-analytics---summary--get-analytics-summary

Retrieves a list of summarised aggregate metrics over a given time period.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/spectrum-analytics_identifier"
query object Optional additionalProperties: false
query.dimensions — Optional $ref: "#/definitions/spectrum-analytics_dimensions"
query.sort — Optional $ref: "#/definitions/spectrum-analytics_sort"
query.until — Optional $ref: "#/definitions/spectrum-analytics_until"
query.metrics — Optional $ref: "#/definitions/spectrum-analytics_metrics"
query.filters — Optional $ref: "#/definitions/spectrum-analytics_filters"
query.since — Optional $ref: "#/definitions/spectrum-analytics_since"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Spectrum applications — cloudflare.spectrum-applications-list-spectrum-applications

Retrieves a list of currently existing Spectrum applications inside a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/spectrum-config_zone_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, result_info will be present in the response. minimum: 1
query.per_page number Optional Sets the maximum number of results per page. default: 20; minimum: 1; maximum: 100
query.direction string Optional Sets the direction by which results are ordered. enum: ["asc","desc"]; default: "asc"
query.order string Optional Application field by which results are ordered. enum: ["protocol","app_id","created_on","modified_on","dns"]; default: "dns"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Spectrum application — cloudflare.spectrum-applications-delete-spectrum-application

Deletes a previously existing application.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/spectrum-config_app_identifier"
path.zone_id — Required $ref: "#/definitions/spectrum-config_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Spectrum application configuration — cloudflare.spectrum-applications-get-spectrum-application-configuration

Gets the application configuration of a specific application inside a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.app_id — Required $ref: "#/definitions/spectrum-config_app_identifier"
path.zone_id — Required $ref: "#/definitions/spectrum-config_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "app_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Spectrum application protocols — cloudflare.spectrum-applications-list-spectrum-application-protocols

Retrieves a list of Spectrum application protocols available for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/spectrum-config_zone_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get quota and availability — cloudflare.speed-get-availabilities

Retrieves quota for all plans, as well as the current zone quota.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tested webpages — cloudflare.speed-list-pages

Lists all webpages which have been tested.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete all page tests — cloudflare.speed-delete-tests

Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
query object Optional additionalProperties: false
query.region — Optional
query.region — Optional allOf[1]; $ref: "#/definitions/observatory_region"
query.region string Optional allOf[2]; default: "us-central1"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List page test history — cloudflare.speed-list-test-history

Test history (list of tests) for a specific webpage.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
query object Optional additionalProperties: false
query.page integer Optional default: 1
query.per_page integer Optional default: 20; minimum: 5; maximum: 50
query.region — Optional
query.region — Optional allOf[1]; $ref: "#/definitions/observatory_region"
query.region string Optional allOf[2]; default: "us-central1"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start page test — cloudflare.speed-create-test

Starts a test for a specific webpage, in a specific region.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
body object Optional
body.region — Optional
body.region — Optional allOf[1]; $ref: "#/definitions/observatory_region"
body.region string Optional allOf[2]; default: "us-central1"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a page test result — cloudflare.speed-get-test

Retrieves the result of a specific test.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
path.test_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com",
    "test_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List core web vital metrics trend — cloudflare.speed-list-page-trend

Lists the core web vital metrics trend over time for a specific page.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
query object Required additionalProperties: false
query.region — Required $ref: "#/definitions/observatory_region"
query.deviceType — Required $ref: "#/definitions/observatory_device_type"
query.start — Required $ref: "#/definitions/observatory_timestamp"
query.end — Optional $ref: "#/definitions/observatory_timestamp"
query.tz string Required The timezone of the start and end timestamps.
query.metrics string Required A comma-separated list of metrics to include in the results.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com"
  },
  "query": {
    "region": "us-central1",
    "deviceType": "DESKTOP",
    "start": "2014-01-01T05:20:00.12345Z",
    "tz": "America/Chicago",
    "metrics": "performanceScore,ttfb,fcp,si,lcp,tti,tbt,cls"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete scheduled page test — cloudflare.speed-delete-test-schedule

Deletes a scheduled test for a page.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
query object Optional additionalProperties: false
query.region — Optional
query.region — Optional allOf[1]; $ref: "#/definitions/observatory_region"
query.region string Optional allOf[2]; default: "us-central1"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a page test schedule — cloudflare.speed-get-scheduled-test

Retrieves the test schedule for a page in a specific region.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
query object Optional additionalProperties: false
query.region — Optional
query.region — Optional allOf[1]; $ref: "#/definitions/observatory_region"
query.region string Optional allOf[2]; default: "us-central1"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create scheduled page test — cloudflare.speed-create-scheduled-test

Creates a scheduled test for a page.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/observatory_identifier"
path.url — Required $ref: "#/definitions/observatory_url"
query object Optional additionalProperties: false
query.region — Optional
query.region — Optional allOf[1]; $ref: "#/definitions/observatory_region"
query.region string Optional allOf[2]; default: "us-central1"
query.frequency — Optional The frequency of the scheduled test. Defaults to WEEKLY for free plans, DAILY for paid plans. $ref: "#/definitions/observatory_schedule_frequency"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "url": "example.com"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Analyze Certificate — cloudflare.analyze-certificate-analyze-certificate

Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.bundle_method — Optional $ref: "#/definitions/tls-certificates-and-hostnames_bundle_method"
body.certificate — Optional $ref: "#/definitions/tls-certificates-and-hostnames_certificate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Certificate Packs — cloudflare.certificate-packs-list-certificate-packs

For a given zone, list all active certificate packs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Number of certificate packs per page. default: 20; minimum: 5; maximum: 50
query.status string Optional Include Certificate Packs of all statuses, not just active ones. enum: ["all"]
query.deploy string Optional Specify the deployment environment for the certificate packs. enum: ["staging","production"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Order Advanced Certificate Manager Certificate Pack — cloudflare.certificate-packs-order-advanced-certificate-manager-certificate-pack

For a given zone, order an advanced certificate pack.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.certificate_authority — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate_authority-2"
body.cloudflare_branding — Optional $ref: "#/definitions/tls-certificates-and-hostnames_cloudflare_branding"
body.hosts — Required $ref: "#/definitions/tls-certificates-and-hostnames_hosts-2"
body.type — Required $ref: "#/definitions/tls-certificates-and-hostnames_advanced_type"
body.validation_method — Required $ref: "#/definitions/tls-certificates-and-hostnames_validation_method"
body.validity_days — Required $ref: "#/definitions/tls-certificates-and-hostnames_validity_days"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "advanced",
    "hosts": [
      "example.com",
      "*.example.com",
      "www.example.com"
    ],
    "validation_method": "txt",
    "validity_days": 14,
    "certificate_authority": "lets_encrypt"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Certificate Pack Quotas — cloudflare.certificate-packs-get-certificate-pack-quotas

For a given zone, list certificate pack quotas.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Advanced Certificate Manager Certificate Pack — cloudflare.certificate-packs-delete-advanced-certificate-manager-cert-c1b2665810

For a given zone, delete an advanced certificate pack.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_pack_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate_pack_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_pack_id": "3822ff90-ea29-44df-9e55-21300bb9419b",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Certificate Pack — cloudflare.certificate-packs-get-certificate-pack

For a given zone, get a certificate pack.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_pack_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate_pack_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_pack_id": "3822ff90-ea29-44df-9e55-21300bb9419b",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restart Validation or Update Advanced Certificate Manager Certificate Pack — cloudflare.certificate-packs-restart-validation-for-advanced-certific-b3c0a565ac

For a given zone, restart validation or add cloudflare branding for an advanced certificate pack. The former is only a validation operation for a Certificate Pack in a validation_timed_out status.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_pack_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_certificate_pack_identifier"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body object Required
body.cloudflare_branding — Optional $ref: "#/definitions/tls-certificates-and-hostnames_cloudflare_branding"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_pack_id": "3822ff90-ea29-44df-9e55-21300bb9419b",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Universal SSL Settings Details — cloudflare.universal-ssl-settings-for-a-zone-universal-ssl-settings-details

Get Universal SSL Settings for a Zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Universal SSL Settings — cloudflare.universal-ssl-settings-for-a-zone-edit-universal-ssl-settings

Patch Universal SSL Settings for a Zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body — Required $ref: "#/definitions/tls-certificates-and-hostnames_universal"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

SSL Verification Details — cloudflare.ssl-verification-ssl-verification-details

Get SSL Verification Info for a Zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
query object Optional additionalProperties: false
query.retry boolean Optional Immediately retry SSL Verification. enum: [true]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit SSL Certificate Pack Validation Method — cloudflare.ssl-verification-edit-ssl-certificate-pack-validation-method

Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_pack_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_cert_pack_uuid"
path.zone_id — Required $ref: "#/definitions/tls-certificates-and-hostnames_identifier"
body — Required $ref: "#/definitions/tls-certificates-and-hostnames_validation_method-3"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_pack_id": "a77f8bd7-3b47-46b4-a6f1-75cf98109948",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "validation_method": "txt"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get zone Stream usage — cloudflare.usage-analytics-get-zone-stream-usage

Retrieve Stream usage analytics for a zone. Returns time-series data for Stream billable minutes viewed. The gateway resolves the zone to its owning account and rewrites this path before forwarding to the backend usage handler.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required Standard Cloudflare hex zone identifier. The API gateway resolves this to the owning account and translates it to an internal numeric ID before forwarding to the backend service. $ref: "#/definitions/usage-analytics_identifier"
query object Optional additionalProperties: false
query.metrics string Optional Comma-separated list of metrics to include in the response. Available metrics depend on the endpoint. Billing usage supports: streamMinutesViewed, rateLimitingRequestsAllowed, loadBalancingQueries, argoAcceleratedBytes, workersRequests, workersKVReads, imageResizingRequests, spectrumBytesTransferred, mediaUniqueTransformations. Stream/media usage supports: streamMinutesViewed.
query.since string Optional Start of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to 6 hours before the current time. format: "date-time"
query.until string Optional End of the time range for the query (inclusive). ISO 8601 timestamp. Defaults to the current time. format: "date-time"
query.time_delta string Optional Time unit to aggregate usage observations into. Data retention is approximately 18 months. The effective number of data points returned depends on the time range and granularity selected. For example, requesting hourly granularity over 18 months could produce up to ~13,000 data points; use the limit parameter to cap results and be aware that responses may be truncated. enum: ["hour","day","week","month","quarter","year"]; default: "hour"
query.limit integer Optional Maximum number of data points to return. The actual number of results depends on the interaction between the time range (since/until) and time_delta granularity. Results are truncated to this limit without error if the time range produces more data points than the limit allows. default: 100; minimum: 1; maximum: 10000
query.filters string Optional Filter expressions to apply to the query. Format: field==value. Multiple filters can be combined.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Zone Subscription — cloudflare.zone-subscription-delete-zone-subscription

Deletes a zone's subscription.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Zone Subscription Details — cloudflare.zone-subscription-zone-subscription-details

Lists zone subscription details.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Zone Subscription — cloudflare.zone-subscription-create-zone-subscription

Create a zone subscription, either plan or add-ons.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zone Subscription — cloudflare.zone-subscription-update-zone-subscription

Updates zone subscriptions, either plan or add-ons.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Zone Subscription — cloudflare.zone-subscription-delete-zone-subscriptions

Deletes a zone's subscription. Retained for audit-log coverage. Use the singular /zones/{zone_id}/subscription path instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Zone Subscription — cloudflare.zone-subscription-create-zone-subscriptions

Create a zone subscription, either plan or add-ons. Retained for audit-log coverage. Use the singular /zones/{zone_id}/subscription path instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Zone Subscription — cloudflare.zone-subscription-update-zone-subscriptions

Updates zone subscriptions, either plan or add-ons. Retained for audit-log coverage. Use the singular /zones/{zone_id}/subscription path instead.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/bill-subs-api_identifier"
body — Required $ref: "#/definitions/bill-subs-api_subscription-v2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete tags from a zone-level resource — cloudflare.tags-zone-delete

Removes all tags from a specific zone-level resource.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/resource-tagging_zone_id"
headers object Optional additionalProperties: false
headers.If-Match string Optional ETag value for optimistic concurrency control. When provided, the server will verify the current resource ETag matches before applying the write. Returns 412 Precondition Failed if the resource has been modified since the ETag was obtained. Omit this header for unconditional writes.
body — Required $ref: "#/definitions/resource-tagging_delete_tags_request_zone_level"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "resource_type": "zone",
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get tags for a zone-level resource — cloudflare.tags-zone-get

Retrieves tags for a specific zone-level resource.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/resource-tagging_zone_id"
query object Required additionalProperties: false
query.resource_id — Required The ID of the resource to retrieve tags for. $ref: "#/definitions/resource-tagging_resource_id"
query.resource_type — Required The type of the resource. $ref: "#/definitions/resource-tagging_zone_resource_type"
query.access_application_id — Optional Access application ID identifier. Required for access_application_policy resources. $ref: "#/definitions/resource-tagging_access_application_id"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "query": {
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_type": "zone"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set tags for a zone-level resource — cloudflare.tags-zone-set

Creates or updates tags for a specific zone-level resource. Replaces all existing tags for the resource.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/resource-tagging_zone_id"
headers object Optional additionalProperties: false
headers.If-Match string Optional ETag value for optimistic concurrency control. When provided, the server will verify the current resource ETag matches before applying the write. Returns 412 Precondition Failed if the resource has been modified since the ETag was obtained. Omit this header for unconditional writes.
body — Required $ref: "#/definitions/resource-tagging_set_tags_request_zone_level"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "resource_type": "zone",
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List token validation configurations — cloudflare.token-validation-config-list

Lists the JWT validation configurations defined for the zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a token validation configuration — cloudflare.token-validation-config-create

Creates a JWT validation configuration for the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body object Required
body.credentials — Required $ref: "#/definitions/api-shield_credentials-request"
body.description — Required $ref: "#/definitions/api-shield_description"
body.title — Required $ref: "#/definitions/api-shield_title"
body.token_sources — Required $ref: "#/definitions/api-shield_token_sources"
body.token_type — Required $ref: "#/definitions/api-shield_token_type"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "title": "Example Token Validation Configuration",
    "description": "Long description for Token Validation Configuration",
    "token_sources": [
      "http.request.headers[\"x-auth\"][0]",
      "http.request.cookies[\"Authorization\"][0]"
    ],
    "token_type": "JWT",
    "credentials": {
      "keys": [
        {
          "kid": "example",
          "kty": "RSA",
          "alg": "RS256",
          "n": "example",
          "e": "example"
        }
      ]
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a token validation configuration — cloudflare.token-validation-config-delete

Deletes a JWT validation configuration from the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.config_id — Required Token Configuration ID $ref: "#/definitions/api-shield_uuid-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "config_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a token validation configuration — cloudflare.token-validation-config-get

Returns a JWT validation configuration by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.config_id — Required Token Configuration ID $ref: "#/definitions/api-shield_uuid-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "config_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a token validation configuration — cloudflare.token-validation-config-edit

Updates only the supplied fields on a JWT validation configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.config_id — Required Token Configuration ID $ref: "#/definitions/api-shield_uuid-2"
body object Required
body.description — Optional $ref: "#/definitions/api-shield_description"
body.title — Optional $ref: "#/definitions/api-shield_title"
body.token_sources — Optional $ref: "#/definitions/api-shield_token_sources"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "config_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit token validation credentials — cloudflare.token-validation-config-credentials-edit

Updates the configuration's complete key set while allowing omitted fields on existing keys to retain stored values. Omitted key identities are removed.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.config_id — Required Token Configuration ID $ref: "#/definitions/api-shield_uuid-2"
body — Required $ref: "#/definitions/api-shield_credentials-patch-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "config_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "body": {
    "keys": [
      {
        "kid": "example",
        "kty": "RSA",
        "alg": "RS256",
        "n": "example",
        "e": "example"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace token validation credentials — cloudflare.token-validation-config-credentials-update

Replaces the configuration's complete key set. Symmetric keys must include their key material.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.config_id — Required Token Configuration ID $ref: "#/definitions/api-shield_uuid-2"
body — Required $ref: "#/definitions/api-shield_credentials-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "config_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "body": {
    "keys": [
      {
        "kid": "example",
        "kty": "RSA",
        "alg": "RS256",
        "n": "example",
        "e": "example"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List token validation rules — cloudflare.token-validation-rules-list

Lists token validation rules for the zone, with filters for configuration, action, state, ID, and host.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.token_configuration array Optional Select rules using any of these token configurations.
query.token_configuration[] — Optional $ref: "#/definitions/api-shield_uuid-2"
query.action — Optional $ref: "#/definitions/api-shield_action"
query.enabled — Optional $ref: "#/definitions/api-shield_enabled"
query.id — Optional Select rules with these IDs. $ref: "#/definitions/api-shield_uuid-2"
query.rule_id — Optional Select rules with these IDs. $ref: "#/definitions/api-shield_uuid-2"
query.host — Optional Select rules with this host in include. $ref: "#/definitions/api-shield_host"
query.hostname — Optional Select rules with this host in include. $ref: "#/definitions/api-shield_host"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit token validation rules — cloudflare.token-validation-rules-bulk-edit

Updates and reorders multiple token validation rules in one request, then returns the updated rules.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body array Required
body[] — Optional
body[] object Optional allOf[1]
body[].id string Required Rule ID this patch applies to allOf[1]; maxLength: 36; format: "uuid"
body[] — Optional allOf[2]; $ref: "#/definitions/api-shield_edit-single-rule-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create token validation rules — cloudflare.token-validation-rules-bulk-create

Creates multiple token validation rules for the zone in one request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
body array Required
body[] — Optional $ref: "#/definitions/api-shield_create-single-rule-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview a token validation rule — cloudflare.token-validation-rules-preview

Returns zone operations annotated as included or excluded to preview the rule's coverage before creation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
query object Optional additionalProperties: false
query.per_page integer Optional Maximum number of results per page. default: 20; minimum: 5; maximum: 50
query.page integer Optional Page number of paginated results. default: 1; minimum: 1
query.state array Optional
query.state[] — Optional $ref: "#/definitions/api-shield_selector-operation-state"
query.host array Optional Filter operations by host.
query.host[] — Optional $ref: "#/definitions/api-shield_host"
query.hostname array Optional Filter operations by host.
query.hostname[] — Optional $ref: "#/definitions/api-shield_host"
query.method array Optional Filter operations by method.
query.method[] — Optional $ref: "#/definitions/api-shield_method"
query.endpoint array Optional Filter operations by endpoint. Allows substring matching.
query.endpoint[] — Optional $ref: "#/definitions/api-shield_endpoint"
body — Required $ref: "#/definitions/api-shield_selector"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a token validation rule — cloudflare.token-validation-rules-delete

Deletes a token validation rule from the zone.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.rule_id — Required Token Validation Rule ID $ref: "#/definitions/api-shield_uuid-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a token validation rule — cloudflare.token-validation-rules-get

Returns a token validation rule by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.rule_id — Required Token Validation Rule ID $ref: "#/definitions/api-shield_uuid-2"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a token validation rule — cloudflare.token-validation-rules-edit

Updates only the supplied fields on a token validation rule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/api-shield_identifier-2"
path.rule_id — Required Token Validation Rule ID $ref: "#/definitions/api-shield_uuid-2"
body — Required $ref: "#/definitions/api-shield_edit-single-rule-request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "rule_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete URL Normalization settings — cloudflare.deleteurlnormalization

Deletes the URL Normalization settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get URL Normalization settings — cloudflare.geturlnormalization

Fetches the current URL Normalization settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update URL Normalization settings — cloudflare.updateurlnormalization

Updates the URL Normalization settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/rulesets_ZoneId"
body — Required $ref: "#/definitions/rulesets_UrlNormalization"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "9f1839b6152d298aca64c4e906b6d074"
  },
  "body": {
    "type": "cloudflare",
    "scope": "incoming"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List waiting rooms for zone — cloudflare.waiting-room-list-waiting-rooms

Lists waiting rooms for zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. Must be a multiple of 5. default: 25; minimum: 5; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create waiting room — cloudflare.waiting-room-create-waiting-room

Creates a new waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_query_waitingroom"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "production_webinar",
    "host": "shop.example.com",
    "new_users_per_minute": 200,
    "total_active_users": 200
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a custom waiting room page preview — cloudflare.waiting-room-create-a-custom-waiting-room-page-preview

Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form http://waitingrooms.dev/preview/<uuid>. You can use the following query parameters to change the state of the preview: 1. force_queue: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll). 2. queue_is_full: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment. 3. queueing_method: The queueing method currently used by the waiting room. - fifo indicates a FIFO queue. - random indicates a Random queue. - passthrough indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if force_queue=true or event=prequeueing — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \"Welcome\". - reject indicates a Reject queue. 4. event: Used to preview a waiting room event. - none indicates no event is occurring. - prequeueing indicates that an event is prequeueing (between prequeue_start_time and event_start_time). - started indicates that an event has started (between event_start_time and event_end_time). 5. shuffle_at_event_start: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to true if an event is active (event is not none).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_query_preview"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "custom_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get zone-level Waiting Room settings — cloudflare.waiting-room-get-zone-settings

Get zone-level Waiting Room settings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch zone-level Waiting Room settings — cloudflare.waiting-room-patch-zone-settings

Patch zone-level Waiting Room settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_zone_settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update zone-level Waiting Room settings — cloudflare.waiting-room-update-zone-settings

Replace zone-level Waiting Room settings.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_zone_settings"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete waiting room — cloudflare.waiting-room-delete-waiting-room

Deletes a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Waiting room details — cloudflare.waiting-room-waiting-room-details

Fetches a single configured waiting room.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch waiting room — cloudflare.waiting-room-patch-waiting-room

Patches a configured waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_query_waitingroom"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "production_webinar",
    "host": "shop.example.com",
    "new_users_per_minute": 200,
    "total_active_users": 200
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update waiting room — cloudflare.waiting-room-update-waiting-room

Updates a configured waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_query_waitingroom"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "production_webinar",
    "host": "shop.example.com",
    "new_users_per_minute": 200,
    "total_active_users": 200
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List events — cloudflare.waiting-room-list-events

Lists events for a waiting room.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
query object Optional additionalProperties: false
query.page number Optional Page number of paginated results. default: 1; minimum: 1
query.per_page number Optional Maximum number of results per page. Must be a multiple of 5. default: 25; minimum: 5; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create event — cloudflare.waiting-room-create-event

Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_query_event"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "production_webinar_event",
    "event_start_time": "2021-09-28T15:30:00Z",
    "event_end_time": "2021-09-28T17:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete event — cloudflare.waiting-room-delete-event

Deletes an event for a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.event_id — Required $ref: "#/definitions/waitingroom_event_id"
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "event_id": "25756b2dfe6e378a06b033b670413757",
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Event details — cloudflare.waiting-room-event-details

Fetches a single configured event for a waiting room.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.event_id — Required $ref: "#/definitions/waitingroom_event_id"
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "event_id": "25756b2dfe6e378a06b033b670413757",
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch event — cloudflare.waiting-room-patch-event

Patches a configured event for a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.event_id — Required $ref: "#/definitions/waitingroom_event_id"
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_query_event"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "event_id": "25756b2dfe6e378a06b033b670413757",
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "production_webinar_event",
    "event_start_time": "2021-09-28T15:30:00Z",
    "event_end_time": "2021-09-28T17:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update event — cloudflare.waiting-room-update-event

Updates a configured event for a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.event_id — Required $ref: "#/definitions/waitingroom_event_id"
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_query_event"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "event_id": "25756b2dfe6e378a06b033b670413757",
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "production_webinar_event",
    "event_start_time": "2021-09-28T15:30:00Z",
    "event_end_time": "2021-09-28T17:00:00Z"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview active event details — cloudflare.waiting-room-preview-active-event-details

Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.event_id — Required $ref: "#/definitions/waitingroom_event_id"
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "event_id": "25756b2dfe6e378a06b033b670413757",
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Waiting Room Rules — cloudflare.waiting-room-list-waiting-room-rules

Lists rules for a waiting room.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Waiting Room Rule — cloudflare.waiting-room-create-waiting-room-rule

Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_create_rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "action": "bypass_waiting_room",
    "expression": "ip.src in {10.20.30.40}"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Waiting Room Rules — cloudflare.waiting-room-replace-waiting-room-rules

Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_update_rules"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": []
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Waiting Room Rule — cloudflare.waiting-room-delete-waiting-room-rule

Deletes a rule for a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/waitingroom_rule_id"
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "25756b2dfe6e378a06b033b670413757",
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Patch Waiting Room Rule — cloudflare.waiting-room-patch-waiting-room-rule

Patches a rule for a waiting room.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id — Required $ref: "#/definitions/waitingroom_rule_id"
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"
body — Required $ref: "#/definitions/waitingroom_patch_rule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "25756b2dfe6e378a06b033b670413757",
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "action": "bypass_waiting_room",
    "expression": "ip.src in {10.20.30.40}"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get waiting room status — cloudflare.waiting-room-get-waiting-room-status

Fetches the status of a configured waiting room. Response fields include: 1. status: String indicating the status of the waiting room. The possible status are: - not_queueing indicates that the configured thresholds have not been met and all users are going through to the origin. - queueing indicates that the thresholds have been met and some users are held in the waiting room. - event_prequeueing indicates that an event is active and is currently prequeueing users before it starts. - suspended indicates that the room is suspended. 2. event_id: String of the current event's id if an event is active, otherwise an empty string. 3. estimated_queued_users: Integer of the estimated number of users currently waiting in the queue. 4. estimated_total_active_users: Integer of the estimated number of users currently active on the origin. 5. max_estimated_time_minutes: Integer of the maximum estimated time currently presented to the users.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.waiting_room_id — Required $ref: "#/definitions/waitingroom_waiting_room_id"
path.zone_id — Required $ref: "#/definitions/waitingroom_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "waiting_room_id": "699d98642c564d2e855e9661899b7252",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Web3 Hostnames — cloudflare.web3-hostname-list-web3-hostnames

List Web3 Hostnames

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/web3_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Web3 Hostname — cloudflare.web3-hostname-create-web3-hostname

Create Web3 Hostname

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/web3_identifier"
body — Required $ref: "#/definitions/web3_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "name": "gateway.example.com",
    "target": "ipfs"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Web3 Hostname Details — cloudflare.web3-hostname-web3-hostname-details

Web3 Hostname Details

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Web3 Hostname — cloudflare.web3-hostname-edit-web3-hostname

Edit Web3 Hostname

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"
body — Required $ref: "#/definitions/web3_modify_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

IPFS Universal Path Gateway Content List Details — cloudflare.web3-hostname-ipfs-universal-path-gateway-content-list-details

IPFS Universal Path Gateway Content List Details

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update IPFS Universal Path Gateway Content List — cloudflare.web3-hostname-update-ipfs-universal-path-gateway-content-list

Update IPFS Universal Path Gateway Content List

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"
body — Required $ref: "#/definitions/web3_content_list_update_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "action": "block",
    "entries": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List IPFS Universal Path Gateway Content List Entries — cloudflare.web3-hostname-list-ipfs-universal-path-gateway-content-list-entries

List IPFS Universal Path Gateway Content List Entries

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create IPFS Universal Path Gateway Content List Entry — cloudflare.web3-hostname-create-ipfs-universal-path-gateway-content-list-entry

Create IPFS Universal Path Gateway Content List Entry

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"
body — Required $ref: "#/definitions/web3_content_list_entry_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "cid",
    "content": "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

IPFS Universal Path Gateway Content List Entry Details — cloudflare.web3-hostname-ipfs-universal-path-gateway-content-list-entry-details

IPFS Universal Path Gateway Content List Entry Details

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.content_list_entry_identifier — Required $ref: "#/definitions/web3_identifier"
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "content_list_entry_identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit IPFS Universal Path Gateway Content List Entry — cloudflare.web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry

Edit IPFS Universal Path Gateway Content List Entry

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.content_list_entry_identifier — Required $ref: "#/definitions/web3_identifier"
path.identifier — Required $ref: "#/definitions/web3_identifier"
path.zone_id — Required $ref: "#/definitions/web3_identifier"
body — Required $ref: "#/definitions/web3_content_list_entry_create_request"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "content_list_entry_identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "identifier": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "type": "cid",
    "content": "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Worker Routes — cloudflare.worker-routes-list-routes

Returns Worker routes for a zone.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Worker Route — cloudflare.worker-routes-create-route

Creates a route that maps a URL pattern to a Worker.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id — Required $ref: "#/definitions/workers_identifier"
body — Required $ref: "#/definitions/workers_route"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "pattern": "example.com/*"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Worker Route — cloudflare.worker-routes-delete-route

Deletes a Worker route.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/workers_identifier"
path.zone_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Worker Route — cloudflare.worker-routes-get-route

Returns information about a Worker route, including URL pattern and Worker.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/workers_identifier"
path.zone_id — Required $ref: "#/definitions/workers_identifier"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Replace Worker Route — cloudflare.worker-routes-update-route

Replaces the URL pattern or Worker associated with a Worker route.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.route_id — Required $ref: "#/definitions/workers_identifier"
path.zone_id — Required $ref: "#/definitions/workers_identifier"
body — Required $ref: "#/definitions/workers_route"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "route_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "body": {
    "pattern": "example.com/*"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Type to search…

↑↓ navigate↵ selectEsc close