Cloudflare integration: operations for AI agents
Cloudflare connects to Type.com as an integration. This page lists the 3803 operations documented for Claude and Codex in Type.com: 1937 read, 904 write, 962 destructive.
About Cloudflare
Cloudflare API reference operations, subject to Type setup, account permissions and product entitlements.
Categories: Security & Identity
How to connect Cloudflare to Type.com
- Connect
- Configure provider-specific API target and authentication setup.
- Access
- Organization connection: one shared account for the workspace.
- MCP
- Selected AI media-generation operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.
To add the connection, follow the steps in Space connections.
Documented operations
3803 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
3803 operations listed.
Health
- Read
Heartbeat response
Used by Kubernetes readiness and liveness probes, and CI builder by executing test/staging.sh.
GET /_heartbeat
Accounts
- Read
List Accounts
List all accounts you have ownership or verified access to.
GET /accounts - Read
Account Details
Get information about a specific account that you are a member of.
GET /accounts/{account_id} - Read
List account organizations
Retrieve a list of the organizations that "contain" this account or are managing it. The returned list will be in order from "root" to "leaf", where the "leaf" will be the organization that _immediately_ contains the specified account.
GET /accounts/{account_id}/organizations - Read
Get account profile
Retrieves the business profile (name, email, phone, address, and external metadata) associated with this account's parent organization customer record. Profiles can be shared across accounts and organizations. Only available to members of an organization that contains the account.
GET /accounts/{account_id}/profile - Write
Create an Account
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.
POST /accounts - Write
Batch move accounts
Batch move a collection of accounts to a specific organization. ⚠️ Not implemented.
POST /accounts/move - Write
Move account to organization
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.
POST /accounts/{account_id}/move - Destructive
Delete a specific account
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
DELETE /accounts/{account_id} - Destructive
Update Account
Update an existing account.
PUT /accounts/{account_id} - Destructive
Update account profile
Updates the business profile (name, email, phone, address, and external metadata) associated with this account's parent organization customer record. Changes apply to every account and organization sharing that profile. Omitted or empty fields are left unchanged. Only available to members of an organization that contains the account.
PUT /accounts/{account_id}/profile
Tseng abuse complaint processor other
- Read
List abuse reports against the account
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.
GET /accounts/{account_id}/abuse-reports - Read
List submitted abuse reports
List abuse reports submitted by the account.
GET /accounts/{account_id}/abuse-reports/submitted - Read
Get a submitted abuse report
Retrieve a report submitted by the account.
GET /accounts/{account_id}/abuse-reports/submitted/{report_id} - Read
List emails sent to an abuse report submitter
List successful emails sent to the submitter of a report submitted by the account. Does not include emails sent to customers or hosts.
GET /accounts/{account_id}/abuse-reports/submitted/{report_id}/emails - Read
Check whether a report can be appealed
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.
GET /accounts/{account_id}/abuse-reports/{report_id}/appeals/eligibility - Read
List abuse report emails
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.
GET /accounts/{account_id}/abuse-reports/{report_id}/emails - Read
List abuse report mitigations
List mitigations done to remediate the abuse report.
GET /accounts/{account_id}/abuse-reports/{report_id}/mitigations - Read
Get an abuse report against the account
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.
GET /accounts/{account_id}/abuse-reports/{report_param} - Write
Request review on mitigations
Request a review of mitigations applied because of an abuse report, or submit a report-level appeal. - To request a review of specific mitigations, send `appeals` with the mitigation IDs and reasons. Repeating a request for a mitigation with an unresolved appeal is idempotent and returns that mitigation in the in-review state. - To submit a report-level appeal, send `type` and, for a `counter_notice`, the counter-notice details in `data`. Report-level appeals are currently available only for DMCA (copyright) reports.
POST /accounts/{account_id}/abuse-reports/{report_id}/mitigations/appeal - Write
Submit an abuse report
Submit an abuse report of a particular type. Requires the abuse-reports entitlement on the account (Enterprise accounts have it by default; other accounts must request access) and an API token with the `Trust and Safety Write` permission. If the account is not entitled, the request is rejected with an HTTP `401` response (see below). Delegated reports: In limited circumstances, Cloudflare works with select customers who have established abuse-handling programs. For these customers, Cloudflare may forward abuse reports directly and in full—including reporter contact information, comments, and supporting evidence—without redaction or preprocessing by Cloudflare. This allows the customer to investigate and respond using their own policies and processes. For delegated reports, the report—including contact information and comments—will be forwarded to the customer in full regardless of the `host_notification` and `owner_notification` values.
POST /accounts/{account_id}/abuse-reports/{report_param}
MCP Portal Analytics
- Read
Per-portal MCP tool-call timeseries
Returns daily or monthly tool-call counts for a portal.
GET /accounts/{account_id}/access/ai-controls/mcp/analytics/portals/{portal_id}/tool-calls/timeseries - Read
Per-server MCP tool-call timeseries
Returns daily or monthly tool-call counts for a server.
GET /accounts/{account_id}/access/ai-controls/mcp/analytics/servers/{server_id}/tool-calls/timeseries - Read
Account-global MCP tool-call timeseries
Returns daily or monthly tool-call counts across the account.
GET /accounts/{account_id}/access/ai-controls/mcp/analytics/tool-calls/timeseries
MCP Portal
- Read
List MCP Portals
Lists all MCP portals configured for the account.
GET /accounts/{account_id}/access/ai-controls/mcp/portals - Read
Read details of an MCP Portal
Read the details of a single MCP Portal, including its configured servers.
GET /accounts/{account_id}/access/ai-controls/mcp/portals/{id} - Read
Resolve an MCP server OAuth 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.
GET /accounts/{account_id}/access/ai-controls/mcp/portals/{portal_id}/servers/{server_id}/effective-redirect-uri - Write
Create a new MCP Portal
Creates a new MCP portal for managing AI tool access through Cloudflare Access.
POST /accounts/{account_id}/access/ai-controls/mcp/portals - Destructive
Delete an MCP Portal
Deletes an MCP portal from the account.
DELETE /accounts/{account_id}/access/ai-controls/mcp/portals/{id} - Destructive
Update an MCP Portal
Updates an MCP portal configuration.
PUT /accounts/{account_id}/access/ai-controls/mcp/portals/{id}
MCP Portal Servers
- Read
List MCP Servers
Lists all MCP servers configured for the account.
GET /accounts/{account_id}/access/ai-controls/mcp/servers - Read
Read the details of an MCP Server
Retrieves an MCP server's configuration and capability sync state.
GET /accounts/{account_id}/access/ai-controls/mcp/servers/{id} - Write
Create a new MCP Server
Creates a new MCP server for connecting to an upstream MCP endpoint.
POST /accounts/{account_id}/access/ai-controls/mcp/servers - Write
Sync MCP Server Capabilities
Syncs an MCP server's capabilities and returns the updated server state, including any connection errors.
POST /accounts/{account_id}/access/ai-controls/mcp/servers/{id}/sync - Destructive
Delete an MCP Server
Deletes an MCP server from the account.
DELETE /accounts/{account_id}/access/ai-controls/mcp/servers/{id} - Destructive
Update an MCP Server
Updates an MCP server's configuration and credentials.
PUT /accounts/{account_id}/access/ai-controls/mcp/servers/{id}
Access applications
- Read
List Access applications
Lists all Access applications in an account.
GET /accounts/{account_id}/access/apps - Read
Get an Access application
Fetches information about an Access application.
GET /accounts/{account_id}/access/apps/{app_id} - Read
Test Access policies
Tests if a specific user has permission to access an application.
GET /accounts/{account_id}/access/apps/{app_id}/user_policy_checks - Write
Add an Access application
Adds a new application to Access.
POST /accounts/{account_id}/access/apps - Write
Update Access application settings
Updates Access application settings.
PATCH /accounts/{account_id}/access/apps/{app_id}/settings - Destructive
Delete an Access application
Deletes an application from Access.
DELETE /accounts/{account_id}/access/apps/{app_id} - Destructive
Update an Access application
Updates an Access application.
PUT /accounts/{account_id}/access/apps/{app_id} - Destructive
Revoke application tokens
Revokes all tokens issued for an application.
POST /accounts/{account_id}/access/apps/{app_id}/revoke_tokens - Destructive
Update Access application settings
Updates Access application settings.
PUT /accounts/{account_id}/access/apps/{app_id}/settings
Access short lived certificate CAs
- Read
List short-lived certificate CAs
Lists short-lived certificate CAs and their public keys.
GET /accounts/{account_id}/access/apps/ca - Read
Get a short-lived certificate CA
Fetches a short-lived certificate CA and its public key.
GET /accounts/{account_id}/access/apps/{app_id}/ca - Write
Create a short-lived certificate CA
Generates a new short-lived certificate CA and public key.
POST /accounts/{account_id}/access/apps/{app_id}/ca - Destructive
Delete a short-lived certificate CA
Deletes a short-lived certificate CA.
DELETE /accounts/{account_id}/access/apps/{app_id}/ca
Access application scoped policies
- Read
List Access application policies
Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application.
GET /accounts/{account_id}/access/apps/{app_id}/policies - Read
Get an Access application policy
Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application.
GET /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id} - Write
Create an Access application 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.
POST /accounts/{account_id}/access/apps/{app_id}/policies - Destructive
Delete an Access application policy
Deletes an Access policy specific to an application. To delete a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.
DELETE /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id} - Destructive
Update an Access application policy
Updates an Access policy specific to an application. To update a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.
PUT /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id} - Destructive
Convert an Access application policy to a reusable policy
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.
PUT /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}/make_reusable
Access Authenticator Device AAGUIDs
- Read
List authenticator device AAGUIDs
Returns a list of Authenticator Device AAGUIDs for MFA configuration.
GET /accounts/{account_id}/access/authenticator_device_aaguids
Access Bookmark applications (Deprecated)
- Read
List Bookmark applications (deprecated)
Lists Bookmark applications.
GET /accounts/{account_id}/access/bookmarks - Read
Get a Bookmark application (deprecated)
Fetches a single Bookmark application.
GET /accounts/{account_id}/access/bookmarks/{bookmark_id} - Write
Create a Bookmark application (deprecated)
Create a new Bookmark application.
POST /accounts/{account_id}/access/bookmarks/{bookmark_id} - Destructive
Delete a Bookmark application (deprecated)
Deletes a Bookmark application.
DELETE /accounts/{account_id}/access/bookmarks/{bookmark_id} - Destructive
Update a Bookmark application (deprecated)
Updates a configured Bookmark application.
PUT /accounts/{account_id}/access/bookmarks/{bookmark_id}
Access m TLS authentication
- Read
List mTLS certificates
Lists all mTLS root certificates.
GET /accounts/{account_id}/access/certificates - Read
List all mTLS hostname settings
List all mTLS hostname settings for this account.
GET /accounts/{account_id}/access/certificates/settings - Read
Get an mTLS certificate
Fetches a single mTLS certificate.
GET /accounts/{account_id}/access/certificates/{certificate_id} - Write
Add an mTLS certificate
Adds a new mTLS root certificate to Access.
POST /accounts/{account_id}/access/certificates - Destructive
Update an mTLS certificate's hostname settings
Updates an mTLS certificate's hostname settings.
PUT /accounts/{account_id}/access/certificates/settings - Destructive
Delete an mTLS certificate
Deletes an mTLS certificate.
DELETE /accounts/{account_id}/access/certificates/{certificate_id} - Destructive
Update an mTLS certificate
Updates a configured mTLS certificate.
PUT /accounts/{account_id}/access/certificates/{certificate_id}
Access custom pages
- Read
List custom pages
List custom pages
GET /accounts/{account_id}/access/custom_pages - Read
Validate a custom page template
Validate a Liquid template and return its errors and warnings without persisting it.
POST /accounts/{account_id}/access/custom_pages/validate - Read
Get a custom page
Fetches a custom page and also returns its HTML.
GET /accounts/{account_id}/access/custom_pages/{custom_page_id} - Write
Create a custom page
Create a custom page
POST /accounts/{account_id}/access/custom_pages - Destructive
Delete a custom page
Delete a custom page
DELETE /accounts/{account_id}/access/custom_pages/{custom_page_id} - Destructive
Update a custom page
Update a custom page
PUT /accounts/{account_id}/access/custom_pages/{custom_page_id}
Gateway CA
- Read
List SSH Certificate Authorities (CA)
Lists SSH Certificate Authorities (CA).
GET /accounts/{account_id}/access/gateway_ca - Write
Add a new SSH Certificate Authority (CA)
Adds a new SSH Certificate Authority (CA).
POST /accounts/{account_id}/access/gateway_ca - Destructive
Delete an SSH Certificate Authority (CA)
Deletes an SSH Certificate Authority.
DELETE /accounts/{account_id}/access/gateway_ca/{certificate_id}
Access groups
- Read
List Access groups
Lists all Access groups.
GET /accounts/{account_id}/access/groups - Read
Get an Access group
Fetches a single Access group.
GET /accounts/{account_id}/access/groups/{group_id} - Write
Create an Access group
Creates a new Access group.
POST /accounts/{account_id}/access/groups - Destructive
Delete an Access group
Deletes an Access group.
DELETE /accounts/{account_id}/access/groups/{group_id} - Destructive
Update an Access group
Updates a configured Access group.
PUT /accounts/{account_id}/access/groups/{group_id}
Access identity providers
- Read
List Access identity providers
Lists all configured identity providers.
GET /accounts/{account_id}/access/identity_providers - Read
Get an Access identity provider
Fetches a configured identity provider.
GET /accounts/{account_id}/access/identity_providers/{identity_provider_id} - Read
List SCIM Group resources
Lists SCIM Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).
GET /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/groups - Read
Get a SCIM Group resource
Returns a SCIM Group resource, including its direct members, synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).
GET /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/groups/{group_id} - Read
List SCIM User resources
Lists SCIM User resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).
GET /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/users - Read
Get a SCIM User resource
Returns a SCIM User resource synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).
GET /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/users/{user_id} - Write
Add an Access identity provider
Adds a new identity provider to Access.
POST /accounts/{account_id}/access/identity_providers - Write
Create SAML encryption certificate for Identity Provider
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. **Workflow for enabling SAML encryption:** 1. Call this endpoint to create and assign a certificate set to the IdP 2. Update the IdP configuration (PUT `/identity_providers/{id}`) with: - `config.enable_encryption: true` - `saml_certificate_set_id: <uid from step 1>` 3. Configure the certificate's public key in your external SAML Identity Provider
POST /accounts/{account_id}/access/identity_providers/{identity_provider_id}/saml_certificate - Destructive
Delete an Access identity provider
Deletes an identity provider from Access.
DELETE /accounts/{account_id}/access/identity_providers/{identity_provider_id} - Destructive
Update an Access identity provider
Updates a configured identity provider.
PUT /accounts/{account_id}/access/identity_providers/{identity_provider_id} - Destructive
Delete a SCIM Group resource
Deletes a SCIM Group resource from the identity provider's SCIM population.
DELETE /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/groups/{group_id} - Destructive
Delete a SCIM User resource
Deletes a SCIM User resource from the identity provider's SCIM population.
DELETE /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/users/{user_id}
Access Id P federation grants
- Read
List IdP federation grants
Lists the IdP federation grants owned by the account.
GET /accounts/{account_id}/access/idp_federation_grants - Read
Get an IdP federation grant
Retrieves a single IdP federation grant by its UID.
GET /accounts/{account_id}/access/idp_federation_grants/{grant_id} - Write
Create an IdP federation grant
Creates an IdP federation grant for the specified identity provider, making it available for federation to other accounts in the same Cloudflare organization. The account must belong to a Cloudflare organization. One-time pin and Cloudflare-managed identity providers cannot be federated. An account can federate at most five identity providers at a time.
POST /accounts/{account_id}/access/idp_federation_grants - Destructive
Delete an IdP federation grant
Deletes an IdP federation grant. The identity provider remains in the account, but it is no longer available for federation to other accounts.
DELETE /accounts/{account_id}/access/idp_federation_grants/{grant_id}
Access key configuration
- Read
Get the Access key configuration
Gets the Access key rotation settings for an account.
GET /accounts/{account_id}/access/keys - Write
Rotate Access keys
Perfoms a key rotation for an account.
POST /accounts/{account_id}/access/keys/rotate - Destructive
Update the Access key configuration
Updates the Access key rotation settings for an account.
PUT /accounts/{account_id}/access/keys
Access authentication logs
- Read
Get Access authentication logs
Gets a list of Access authentication audit logs for an account.
GET /accounts/{account_id}/access/logs/access_requests
Access JIT request logs
- Read
List Access JIT request logs
Lists account-wide Access JIT request logs reconstructed from request lifecycle events.
GET /accounts/{account_id}/access/logs/jit_requests - Read
Get an Access JIT request log
Gets an account-scoped Access JIT request summary and its lifecycle events in chronological order.
GET /accounts/{account_id}/access/logs/jit_requests/{knock_request_id}
Access SCIM update logs
- Read
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).
GET /accounts/{account_id}/access/logs/scim/updates
Zero Trust organization
- Read
Get your Zero Trust organization
Returns the configuration for your Zero Trust organization.
GET /accounts/{account_id}/access/organizations - Read
Get your Zero Trust organization DoH settings
Returns the DoH settings for your Zero Trust organization.
GET /accounts/{account_id}/access/organizations/doh - Read
Get Zero Trust organization trust settings
Returns the trust settings for your Zero Trust organization.
GET /accounts/{account_id}/access/organizations/trust_settings - Write
Update Zero Trust organization trust settings
Updates the trust settings for your Zero Trust organization.
PATCH /accounts/{account_id}/access/organizations/trust_settings - Destructive
Create your Zero Trust organization
Sets up a Zero Trust organization for your account.
POST /accounts/{account_id}/access/organizations - Destructive
Update your Zero Trust organization
Updates the configuration for your Zero Trust organization.
PUT /accounts/{account_id}/access/organizations - Destructive
Update your Zero Trust organization DoH settings
Updates the DoH settings for your Zero Trust organization.
PUT /accounts/{account_id}/access/organizations/doh - Destructive
Revoke all Access tokens for a user
Revokes a user's access across all applications.
POST /accounts/{account_id}/access/organizations/revoke_user - Destructive
Replace Zero Trust organization trust settings
Replaces the trust settings for your Zero Trust organization.
PUT /accounts/{account_id}/access/organizations/trust_settings
Access reusable policies
- Read
List Access reusable policies
Lists Access reusable policies.
GET /accounts/{account_id}/access/policies - Read
Get an Access reusable policy
Fetches a single Access reusable policy.
GET /accounts/{account_id}/access/policies/{policy_id} - Write
Create an Access reusable policy
Creates a new Access reusable policy.
POST /accounts/{account_id}/access/policies - Destructive
Delete an Access reusable policy
Deletes an Access reusable policy.
DELETE /accounts/{account_id}/access/policies/{policy_id} - Destructive
Update an Access reusable policy
Updates a Access reusable policy.
PUT /accounts/{account_id}/access/policies/{policy_id}
Access policy tester
- Read
Get the current status of a given Access policy test
Fetches the current status of a given Access policy test.
GET /accounts/{account_id}/access/policy-tests/{policy_test_id} - Read
Get an Access policy test users page
Fetches a single page of user results from an Access policy test.
GET /accounts/{account_id}/access/policy-tests/{policy_test_id}/users - Write
Start Access policy test
Starts an Access policy test.
POST /accounts/{account_id}/access/policy-tests
Access SAML encryption certificates
- Read
List SAML 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.
GET /accounts/{account_id}/access/saml_certificates - Read
Get SAML certificate set
Retrieves a specific SAML encryption certificate set by its UID, including both current and previous certificates if available.
GET /accounts/{account_id}/access/saml_certificates/{saml_cert_set_id} - Read
Download current certificate in PEM format
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.
GET /accounts/{account_id}/access/saml_certificates/{saml_cert_set_id}/pem - Destructive
Rotate SAML 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 endpoint ensures zero-downtime rotation by maintaining both current and previous certificates during the transition period, allowing IdPs time to update their configurations. Automated rotation happens 30 days before a current certificate's expiration.
POST /accounts/{account_id}/access/saml_certificates/{saml_cert_set_id}/rotate
Zero Trust seats
- Destructive
Update a user seat
Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false.
PATCH /accounts/{account_id}/access/seats
Access service tokens
- Read
List service tokens
Lists all service tokens.
GET /accounts/{account_id}/access/service_tokens - Read
Get a service token
Fetches a single service token.
GET /accounts/{account_id}/access/service_tokens/{service_token_id} - Write
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.
POST /accounts/{account_id}/access/service_tokens - Write
Refresh a service token
Refreshes the expiration of a service token.
POST /accounts/{account_id}/access/service_tokens/{service_token_id}/refresh - Destructive
Delete a service token
Deletes a service token.
DELETE /accounts/{account_id}/access/service_tokens/{service_token_id} - Destructive
Update a service token
Updates a configured service token.
PUT /accounts/{account_id}/access/service_tokens/{service_token_id} - Destructive
Rotate a service token
Generates a new Client Secret for a service token and revokes the old one.
POST /accounts/{account_id}/access/service_tokens/{service_token_id}/rotate
Access tags
- Read
List tags
List tags
GET /accounts/{account_id}/access/tags - Read
Get a tag
Get a tag
GET /accounts/{account_id}/access/tags/{tag_name} - Write
Create a tag
Create a tag
POST /accounts/{account_id}/access/tags - Destructive
Delete a tag
Delete a tag
DELETE /accounts/{account_id}/access/tags/{tag_name} - Destructive
Update a tag
Update a tag
PUT /accounts/{account_id}/access/tags/{tag_name}
Access user populations
- Read
List user populations
Lists the user populations in an account.
GET /accounts/{account_id}/access/user_populations - Read
Get a user population
Fetches a user population.
GET /accounts/{account_id}/access/user_populations/{user_population_id} - Write
Create a user population
Creates a user population in an account.
POST /accounts/{account_id}/access/user_populations - Destructive
Delete a user population
Deletes a user population that is not attached to an application.
DELETE /accounts/{account_id}/access/user_populations/{user_population_id} - Destructive
Update a user population
Updates a user population's name.
PUT /accounts/{account_id}/access/user_populations/{user_population_id}
Access user population users
- Read
List users in a user population
Lists SCIM users in a user population.
GET /accounts/{account_id}/access/user_populations/{user_population_id}/users - Read
Get a user population user
Fetches a SCIM user from a user population.
GET /accounts/{account_id}/access/user_populations/{user_population_id}/users/{user_id} - Write
Create a user population user
Creates a SCIM user in a user population.
POST /accounts/{account_id}/access/user_populations/{user_population_id}/users - Write
Update a user population user
Updates a SCIM user in a user population.
PATCH /accounts/{account_id}/access/user_populations/{user_population_id}/users/{user_id} - Destructive
Delete a user population user
Deletes a SCIM user from a user population.
DELETE /accounts/{account_id}/access/user_populations/{user_population_id}/users/{user_id} - Destructive
Replace a user population user
Replaces a SCIM user in a user population.
PUT /accounts/{account_id}/access/user_populations/{user_population_id}/users/{user_id}
Zero Trust users
- Read
Get users
Gets a list of users for an account.
GET /accounts/{account_id}/access/users - Read
Get a user
Gets a specific user for an account.
GET /accounts/{account_id}/access/users/{user_id} - Read
Get active sessions
Get active sessions for a single user.
GET /accounts/{account_id}/access/users/{user_id}/active_sessions - Read
Get single active session
Get an active session for a single user.
GET /accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce} - Read
Get failed logins
Get all failed login attempts for a single user.
GET /accounts/{account_id}/access/users/{user_id}/failed_logins - Read
Get last seen identity
Get last seen identity for a single user.
GET /accounts/{account_id}/access/users/{user_id}/last_seen_identity - Write
Create a user
Creates a new user.
POST /accounts/{account_id}/access/users - Destructive
Delete a user
Deletes a specific user for an account. This will also revoke any active seats and tokens for the user.
DELETE /accounts/{account_id}/access/users/{user_id} - Destructive
Update a user
Updates a specific user's name for an account. Requires the user's current email as confirmation (email cannot be changed).
PUT /accounts/{account_id}/access/users/{user_id} - Destructive
Delete a user's 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.
DELETE /accounts/{account_id}/access/users/{user_id}/mfa_authenticators/{authenticator_id} - Destructive
Delete a user's 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.
DELETE /accounts/{account_id}/access/users/{user_id}/passkeys/{authenticator_id}
IP Address Management Address Maps
- Read
List Address Maps
List all address maps owned by the account.
GET /accounts/{account_id}/addressing/address_maps - Read
Address Map Details
Show a particular address map owned by the account.
GET /accounts/{account_id}/addressing/address_maps/{address_map_id} - Write
Create Address Map
Create a new address map under the account.
POST /accounts/{account_id}/addressing/address_maps - Write
Update Address Map
Modify properties of an address map owned by the account.
PATCH /accounts/{account_id}/addressing/address_maps/{address_map_id} - Write
Add Multiple IPs to an Address Map
Add multiple IPs to a particular address map.
POST /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips - Write
Add Multiple Zones to an Address Map
Add multiple zones as members of a particular address map.
POST /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones - Destructive
Delete Address Map
Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.
DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id} - Destructive
Remove an account membership from an Address Map
Remove an account as a member of a particular address map.
DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{member_account_id} - Destructive
Add an account membership to an Address Map
Add an account as a member of a particular address map.
PUT /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{member_account_id} - Destructive
Remove Multiple IPs from an Address Map
Remove multiple IPs from a particular address map.
DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips - Destructive
Remove an IP from an Address Map
Remove an IP from a particular address map.
DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address} - Destructive
Add an IP to an Address Map
Add an IP from a prefix owned by the account to a particular address map.
PUT /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address} - Destructive
Remove Multiple Zones from an Address Map
Remove multiple zones as members of a particular address map.
DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones - Destructive
Remove a zone membership from an Address Map
Remove a zone as a member of a particular address map.
DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{member_zone_id} - Destructive
Add a zone membership to an Address Map
Add a zone as a member of a particular address map.
PUT /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{member_zone_id}
IP Address Management Leases
- Read
List Leases
List all leases owned by the account.
GET /accounts/{account_id}/addressing/leases
IP Address Management Prefixes
- Read
List LOA Documents
List all LOA documents uploaded under the account.
GET /accounts/{account_id}/addressing/loa_documents - Read
Download LOA Document
Download specified LOA document under the account.
GET /accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download - Read
List Prefixes
List all prefixes owned by the account.
GET /accounts/{account_id}/addressing/prefixes - Read
Prefix Details
List a particular prefix owned by the account.
GET /accounts/{account_id}/addressing/prefixes/{prefix_id} - Read
Validate Prefix
Triggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership.
POST /accounts/{account_id}/addressing/prefixes/{prefix_id}/validate - Write
Upload LOA Document
Submit LOA document (pdf format) under the account.
POST /accounts/{account_id}/addressing/loa_documents - Write
Add Prefix
Add a new prefix under the account.
POST /accounts/{account_id}/addressing/prefixes - Write
Update Prefix Description
Modify the description for a prefix owned by the account.
PATCH /accounts/{account_id}/addressing/prefixes/{prefix_id} - Destructive
Delete Prefix
Delete an unapproved prefix owned by the account.
DELETE /accounts/{account_id}/addressing/prefixes/{prefix_id}
IP Address Management BGP Prefixes
- Read
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.
GET /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes - Read
Fetch BGP Prefix
Retrieve a single BGP Prefix according to its identifier
GET /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id} - Write
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.
POST /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes - Write
Update BGP Prefix
Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).
PATCH /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id} - Destructive
Delete BGP Prefix
Delete a BGP Prefix associated with the specified IP Prefix. A BGP Prefix must be withdrawn before it can be deleted.
DELETE /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
IP Address Management Dynamic Advertisement
- Read
Get Advertisement Status (deprecated)
View the current advertisement state for a prefix. **Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix.
GET /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status - Write
Update Prefix Dynamic Advertisement Status (deprecated)
Advertise or withdraw the BGP route for a prefix. **Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix.
PATCH /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status
IP Address Management Service Bindings
- Read
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.
GET /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings - Read
Get Service Binding
Fetch a single Service Binding
GET /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id} - Read
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.
GET /accounts/{account_id}/addressing/services - Write
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](https://developers.cloudflare.com/byoip/service-bindings/) for compatibility details.
POST /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings - Destructive
Delete Service Binding
Delete a Service Binding
DELETE /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}
IP Address Management Prefix Delegation
- Read
List Prefix Delegations
List all delegations for a given account IP prefix.
GET /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations - Write
Create Prefix Delegation
Create a new account delegation for a given IP prefix.
POST /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations - Destructive
Delete Prefix Delegation
Delete an account delegation for a given IP prefix.
DELETE /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}
DLS Regional Services
- Read
List Regions
List all Regional Services regions available for use by this account.
GET /accounts/{account_id}/addressing/regional_hostnames/regions - Read
List Regional Hostnames
List all Regional Hostnames within a zone.
GET /zones/{zone_id}/addressing/regional_hostnames - Read
Fetch Regional Hostname
Fetch the configuration for a specific Regional Hostname, within a zone.
GET /zones/{zone_id}/addressing/regional_hostnames/{hostname} - Write
Create Regional Hostname
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](https://developers.cloudflare.com/data-localization/regional-services/get-started/).
POST /zones/{zone_id}/addressing/regional_hostnames - Write
Update Regional Hostname
Update the configuration for a specific Regional Hostname. Only the region_key of a hostname is mutable.
PATCH /zones/{zone_id}/addressing/regional_hostnames/{hostname} - Destructive
Delete Regional Hostname
Delete the region configuration for a specific Regional Hostname.
DELETE /zones/{zone_id}/addressing/regional_hostnames/{hostname}
Namespaces
- Read
List namespaces
Lists all namespaces for the given account. Results are paginated.
GET /accounts/{account_id}/agent-memory/namespaces - Read
Get a namespace
Gets a namespace by name.
GET /accounts/{account_id}/agent-memory/namespaces/{namespace_name} - Write
Create a namespace
Creates a new memory namespace owned by the account.
POST /accounts/{account_id}/agent-memory/namespaces - Destructive
Delete a namespace
Deletes a namespace.
DELETE /accounts/{account_id}/agent-memory/namespaces/{namespace_name}
Memory
- Read
List profiles
Lists the profiles of a namespace, ordered by name. A profile appears once it has been used.
GET /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles - Read
List memories
List memories stored in a profile.
GET /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/memories - Read
Get a memory
Retrieves a memory by ID.
GET /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/memories/{memory_id} - Read
Get a profile summary
Generates a paste-ready prompt block summarizing everything stored in a memory profile.
POST /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/summary - Write
Ingest messages
Processes a conversation and extracts structured memories from it. Agent Memory identifies facts, events, instructions, and tasks automatically.
POST /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/ingest - Write
Recall memories
Retrieves memories relevant to the query and returns a synthesized answer.
POST /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/recall - Write
Remember a memory
Stores a single memory explicitly.
POST /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/remember - Destructive
Delete a profile
Marks a profile for deletion.
DELETE /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name} - Destructive
Delete a memory
Deletes a memory by ID. Removes the memory and any source messages linked to it. Returns the deleted memory.
DELETE /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/memories/{memory_id} - Destructive
Delete a session
Marks all memories and messages in a profile that are tagged with the given session ID for deletion.
DELETE /accounts/{account_id}/agent-memory/namespaces/{namespace_name}/profiles/{profile_name}/sessions/{session_id}
AI Gateway
- Read
Get credit balance
Retrieve the current credit balance, payment method info, and top-up configuration.
GET /accounts/{account_id}/ai-gateway/billing/credit-balance - Read
Get invoice history
Retrieve a list of past invoices with pagination, optionally filtered by type.
GET /accounts/{account_id}/ai-gateway/billing/invoice-history - Read
Get invoice preview
Retrieve a preview of the upcoming invoice including line items and tax.
GET /accounts/{account_id}/ai-gateway/billing/invoice-preview - Read
Get spending limit (deprecated)
Retrieve the current spending limit configuration for the account.
GET /accounts/{account_id}/ai-gateway/billing/spending-limit - Read
Get auto top-up configuration
Retrieve the current auto top-up threshold, amount, and any error state.
GET /accounts/{account_id}/ai-gateway/billing/topup/config - Read
Get top-up 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.
POST /accounts/{account_id}/ai-gateway/billing/topup/eligibility - Read
Get account top-up limits
Retrieve the minimum and maximum allowed top-up amounts (in cents) for this account.
GET /accounts/{account_id}/ai-gateway/billing/topup/limits - Read
Check top-up status
Get the payment processing status of a top-up by its top-up identifier.
POST /accounts/{account_id}/ai-gateway/billing/topup/status - Read
Get usage history
Retrieve AI Gateway usage cost, in US dollars, aggregated by hour or day for the given time range.
GET /accounts/{account_id}/ai-gateway/billing/usage-history - Read
Search the web through AI Gateway
Run a web search through a configured AI Gateway.
POST /accounts/{account_id}/ai/websearch - Write
Set spending limit (deprecated) (deprecated)
Deprecated: spending limits can no longer be created, enabled, or modified and this endpoint always responds 403. Use the new AI Gateway spend limits instead: https://developers.cloudflare.com/ai-gateway/features/spend-limits/. Existing limits can be removed via DELETE /spending-limit.
POST /accounts/{account_id}/ai-gateway/billing/spending-limit - Write
Create a top-up
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.
POST /accounts/{account_id}/ai-gateway/billing/topup - Write
Set auto top-up configuration
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.
POST /accounts/{account_id}/ai-gateway/billing/topup/config - Destructive
Delete spending limit (deprecated)
Remove the spending limit for the account.
DELETE /accounts/{account_id}/ai-gateway/billing/spending-limit - Destructive
Delete auto top-up configuration
Remove the auto top-up configuration for the account. Dashboard sessions only: API token, OAuth, and service credentials are rejected with 403.
DELETE /accounts/{account_id}/ai-gateway/billing/topup/config
AI Gateway Custom Providers
- Read
List custom providers
Lists the custom providers configured for the account, ordered by position and then name.
GET /accounts/{account_id}/ai-gateway/custom-providers - Read
Get a custom provider
Retrieves a custom provider, including its slug, base URL, and custom headers.
GET /accounts/{account_id}/ai-gateway/custom-providers/{id} - Write
Create a custom 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.
POST /accounts/{account_id}/ai-gateway/custom-providers - Write
Update a custom provider
Updates the specified fields of a custom provider. Changes clear cached entries for the provider.
PATCH /accounts/{account_id}/ai-gateway/custom-providers/{id} - Destructive
Delete a custom provider
Deletes a custom provider and every pricing rule that belongs to it.
DELETE /accounts/{account_id}/ai-gateway/custom-providers/{id}
AI Gateway Custom Provider Costs
- Read
List custom provider pricing rules
Lists the pricing rules for custom providers in the account, most recently modified first.
GET /accounts/{account_id}/ai-gateway/custom-providers/costs - Read
Get a custom provider pricing rule
Retrieves a custom provider pricing rule, including its model match rule and token prices.
GET /accounts/{account_id}/ai-gateway/custom-providers/costs/{id} - Write
Create a custom provider pricing rule
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.
POST /accounts/{account_id}/ai-gateway/custom-providers/costs - Write
Update a custom provider pricing rule
Updates the specified fields of a custom provider pricing rule. Changes clear cached costs for the matched model.
PATCH /accounts/{account_id}/ai-gateway/custom-providers/costs/{id} - Destructive
Delete a custom provider pricing rule
Deletes a custom provider pricing rule. Requests to the matched model stop using its prices.
DELETE /accounts/{account_id}/ai-gateway/custom-providers/costs/{id}
AI Gateway Evaluations
- Read
List evaluator types (deprecated)
Lists the evaluator types that evaluations can use to score AI Gateway responses. Evaluations are deprecated and unavailable to new accounts.
GET /accounts/{account_id}/ai-gateway/evaluation-types - Read
List evaluations (deprecated)
Lists the evaluations run on an AI Gateway. Evaluations and datasets are deprecated and unavailable to new accounts.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations - Read
Get an evaluation (deprecated)
Retrieves an evaluation and its results. Evaluations and datasets are deprecated and unavailable to new accounts.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id} - Write
Create an evaluation (deprecated)
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.
POST /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations - Destructive
Delete an evaluation (deprecated)
Deletes an evaluation and its results. Evaluations and datasets are deprecated and unavailable to new accounts.
DELETE /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}
AI Gateway Gateways
- Read
List gateways
Lists the AI Gateways in the account. Use `search` to filter by gateway ID.
GET /accounts/{account_id}/ai-gateway/gateways - Read
Get Gateway URL
Retrieves the endpoint URL for an AI Gateway.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/url/{provider} - Read
Get a gateway
Retrieves the configuration of an AI Gateway.
GET /accounts/{account_id}/ai-gateway/gateways/{id} - Write
Create a 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.
POST /accounts/{account_id}/ai-gateway/gateways - Destructive
Delete a gateway
Permanently deletes an AI Gateway, its configuration, and its stored logs.
DELETE /accounts/{account_id}/ai-gateway/gateways/{id} - Destructive
Update a gateway
Updates the configuration of an AI Gateway, such as its caching, rate limiting, logging, and authentication settings.
PUT /accounts/{account_id}/ai-gateway/gateways/{id}
AI Gateway Custom Domains
- Read
List custom domains
Lists the custom domains attached to an AI Gateway, including the certificate and validation status of each domain.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/custom-domains - Read
Get a custom domain
Retrieves a custom domain attached to an AI Gateway, including its status and CNAME target.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/custom-domains/{hostname} - Write
Create a custom domain for a gateway
Provisions a Cloudflare-for-SaaS custom hostname and returns the CNAME target to point DNS at.
POST /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/custom-domains - Destructive
Delete a custom domain
Deletes a custom domain from an AI Gateway and removes its Cloudflare for SaaS custom hostname.
DELETE /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/custom-domains/{hostname}
AI Gateway Datasets
- Read
List datasets (deprecated)
Lists the datasets defined for an AI Gateway. Evaluations and datasets are deprecated and unavailable to new accounts.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets - Read
Get a dataset (deprecated)
Retrieves a dataset and its log filters. Evaluations and datasets are deprecated and unavailable to new accounts.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id} - Write
Create a dataset (deprecated)
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.
POST /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets - Destructive
Delete a dataset (deprecated)
Deletes a dataset. Evaluations and datasets are deprecated and unavailable to new accounts.
DELETE /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id} - Destructive
Update a dataset (deprecated)
Replaces the name, log filters, and enabled state of a dataset. Evaluations and datasets are deprecated and unavailable to new accounts.
PUT /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}
AI Gateway Logs
- Read
List Gateway Logs
Lists request/response log entries for the AI gateway with filtering and pagination.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs - Read
Get Gateway Log Detail
Retrieves detailed information for a specific AI Gateway log entry.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id} - Read
Get Gateway Log Request
Retrieves the original request payload for an AI Gateway log entry.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/request - Read
Get Gateway Log Response
Retrieves the response payload for an AI Gateway log entry.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/response - Write
Patch Gateway Log
Updates metadata for an AI Gateway log entry.
PATCH /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id} - Destructive
Delete Gateway Logs
Deletes gateway log entries matching the specified criteria.
DELETE /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs
AI Gateway Provider Configs
- Read
List provider keys
Lists the provider keys stored for an AI Gateway. Responses show a masked preview of each key, never the key itself.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs - Read
Get a provider key
Retrieves a provider key configuration for an AI Gateway. The response shows a masked preview of the key, never the key itself.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs/{id} - Write
Store a provider key
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.
POST /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs - Destructive
Delete a provider key
Deletes a provider key configuration from an AI Gateway and deletes its secret from the Secrets Store.
DELETE /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs/{id} - Destructive
Rotate a provider key
Replaces the stored API key of a provider key configuration. Only the key can change.
PUT /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs/{id}
AI Gateway Dynamic Routes
- Read
List dynamic routes
Lists the dynamic routes configured on an AI Gateway.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes - Read
Get a dynamic route
Retrieves a dynamic route with its routing elements, active version, and current deployment.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id} - Read
List dynamic route deployments
Lists the deployment history of a dynamic route.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments - Read
List dynamic route versions
Lists the saved versions of a dynamic route.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions - Read
Get a dynamic route version
Retrieves a saved version of a dynamic route, including its routing elements.
GET /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions/{version_id} - Write
Create a 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.
POST /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes - Write
Rename a dynamic route
Updates the name of a dynamic route. To change routing behaviour, create and deploy a new version.
PATCH /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id} - Write
Deploy a dynamic route version
Deploys the specified version of a dynamic route so that it serves traffic. Deploy an earlier version to roll back.
POST /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments - Write
Create a 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.
POST /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions - Destructive
Delete a dynamic route
Deletes a dynamic route from an AI Gateway.
DELETE /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}
Account
- Read
Get AI Gateway logging state
Returns the canonical logging platform and migration availability for an account.
GET /accounts/{account_id}/ai-gateway/logging-state - Read
Get build-minute availability
Return whether the account's build-minute allowance is exhausted and when it refreshes.
GET /accounts/{account_id}/builds/account/limits - Write
Migrate AI Gateway logging to Workers Observability
Irreversibly migrates an eligible account to Workers Observability logging.
PATCH /accounts/{account_id}/ai-gateway/logging-state
AI Search Instances
- Read
List AI Search instances. (deprecated)
Lists all AI Search instances in the account. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
GET /accounts/{account_id}/ai-search/instances - Read
Get an AI Search instance. (deprecated)
Retrieve the configuration and status of an AI Search instance. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
GET /accounts/{account_id}/ai-search/instances/{id} - Read
Get instance statistics. (deprecated)
Retrieve usage and indexing statistics for an AI Search instance. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
GET /accounts/{account_id}/ai-search/instances/{id}/stats - Read
List AI Search instances.
Lists all AI Search instances in the account.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances - Read
Get an AI Search instance.
Retrieve the configuration and status of an AI Search instance.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id} - Read
Search
Executes a semantic search query against an AI Search instance to find relevant indexed content.
POST /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/search - Read
Get instance statistics.
Retrieve usage and indexing statistics for an AI Search instance.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/stats - Write
Create an AI Search instance. (deprecated)
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. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
POST /accounts/{account_id}/ai-search/instances - Write
Chat Completions (deprecated)
Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
POST /accounts/{account_id}/ai-search/instances/{id}/chat/completions - Write
Search (deprecated)
Executes a semantic search query against an AI Search instance to find relevant indexed content. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
POST /accounts/{account_id}/ai-search/instances/{id}/search - Write
Create an AI Search 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.
POST /accounts/{account_id}/ai-search/namespaces/{namespace}/instances - Write
Chat Completions
Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses.
POST /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/chat/completions - Destructive
Delete an AI Search instance. (deprecated)
Deletes an AI Search instance and all its indexed data permanently. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
DELETE /accounts/{account_id}/ai-search/instances/{id} - Destructive
Update an AI Search instance. (deprecated)
Updates the configuration of an AI Search instance. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
PUT /accounts/{account_id}/ai-search/instances/{id} - Destructive
Delete an AI Search instance.
Deletes an AI Search instance and all its indexed data permanently.
DELETE /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id} - Destructive
Update an AI Search instance.
Updates the configuration of an AI Search instance.
PUT /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id} - Destructive
Purge search cache.
Purges all cached search results for an AI Search instance. A new internal cache key is generated, immediately orphaning all prior cached entries.
POST /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/purge_cache
AI Search Instances Jobs
- Read
List Jobs (deprecated)
Lists indexing jobs for an AI Search instance. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
GET /accounts/{account_id}/ai-search/instances/{id}/jobs - Read
Get a Job Details (deprecated)
Retrieves details for a specific AI Search indexing job. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
GET /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id} - Read
List Job Logs (deprecated)
Lists log entries for an AI Search indexing job. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
GET /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs - Read
List Jobs
Lists indexing jobs for an AI Search instance.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/jobs - Read
Get a Job Details
Retrieves details for a specific AI Search indexing job.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/jobs/{job_id} - Read
List Job Logs
Lists log entries for an AI Search indexing job.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/jobs/{job_id}/logs - Write
Create new job (deprecated)
Creates a new indexing job for an AI Search instance. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
POST /accounts/{account_id}/ai-search/instances/{id}/jobs - Write
Create new job
Creates a new indexing job for an AI Search instance.
POST /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/jobs - Destructive
Cancel an indexing job. (deprecated)
Cancels an in-progress indexing job for an AI Search instance. Deprecated: use /accounts/{account_id}/ai-search/namespaces/{namespace}/instances (and descendant paths) instead.
PATCH /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id} - Destructive
Cancel an indexing job.
Cancels an in-progress indexing job for an AI Search instance.
PATCH /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/jobs/{job_id}
AI Search Namespaces
- Read
List namespaces
Lists namespaces in the account, including their descriptions and creation times.
GET /accounts/{account_id}/ai-search/namespaces - Read
Get a namespace
Retrieve a namespace and its description.
GET /accounts/{account_id}/ai-search/namespaces/{name} - Write
Create a namespace
Create a namespace for organizing AI Search instances.
POST /accounts/{account_id}/ai-search/namespaces - Write
Move an instance to a different namespace.
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).
PATCH /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id} - Destructive
Delete a 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.
DELETE /accounts/{account_id}/ai-search/namespaces/{name} - Destructive
Update a 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.
PUT /accounts/{account_id}/ai-search/namespaces/{name}
AI Search Instances Items
- Read
Items List.
Lists indexed items in an AI Search instance.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items - Read
Get Item.
Retrieves a specific indexed item from an AI Search instance.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items/{item_id} - Read
List Item Chunks.
Lists chunks for a specific item in an AI Search instance, including their text content.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items/{item_id}/chunks - Read
Download Item Content.
Downloads the raw file content for a specific item from the managed AI Search instance storage.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items/{item_id}/download - Read
Item Logs.
Lists processing logs for a specific item in an AI Search instance.
GET /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items/{item_id}/logs - Write
Upload Item.
Uploads a file to a managed AI Search instance via multipart/form-data.
POST /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items - Write
Sync Item.
Synchronizes an item to an AI Search instance index.
PATCH /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items/{item_id} - Destructive
Create or Update Item.
Creates or updates an indexed item in an AI Search instance.
PUT /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items - Destructive
Delete Item.
Deletes a file from a managed AI Search instance and removes its indexed data.
DELETE /accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/items/{item_id}
AI Search Account Search
- Write
Multi-Instance Chat Completions
Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response.
POST /accounts/{account_id}/ai-search/namespaces/{name}/chat/completions - Write
Multi-Instance Search
Performs a semantic search query against multiple AI Search instances in parallel, merging the retrieved results into a single ranked response.
POST /accounts/{account_id}/ai-search/namespaces/{name}/search
AI Search Tokens
- Read
List tokens
Lists stored AI Search credentials in the account without exposing their secrets.
GET /accounts/{account_id}/ai-search/tokens - Read
Get a token
Retrieve a stored AI Search credential without exposing its secret.
GET /accounts/{account_id}/ai-search/tokens/{id} - Write
Create a token
Create a stored Cloudflare credential for an AI Search instance to access its data source.
POST /accounts/{account_id}/ai-search/tokens - Destructive
Delete a token
Deletes a stored AI Search credential permanently. Credentials in use by an instance cannot be deleted.
DELETE /accounts/{account_id}/ai-search/tokens/{id} - Destructive
Update a token
Replace a stored AI Search credential and invalidate cached credentials for instances that use it.
PUT /accounts/{account_id}/ai-search/tokens/{id}
Workers AI
- Read
Author Search
Searches Workers AI models by author or organization name.
GET /accounts/{account_id}/ai/authors/search - Read
Get an AI model's input and output schemas
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.
GET /accounts/{account_id}/ai/models/schema - Read
Model Search
Searches Workers AI models by name or description.
GET /accounts/{account_id}/ai/models/search - Read
Task Search
Searches Workers AI models by task type (e.g., text-generation, embeddings).
GET /accounts/{account_id}/ai/tasks/search - Read
List supported Markdown conversion formats
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.
GET /accounts/{account_id}/ai/tomarkdown/supported - Write
Run an AI model with request options
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. Use options.extraHeaders to pass additional provider headers. Accepts Workers AI model identifiers and AI Gateway provider model identifiers. See the [Workers AI model catalog](https://developers.cloudflare.com/workers-ai/models/) for Workers AI model inputs, or the provider's documentation for models accessed through AI Gateway.
POST /accounts/{account_id}/ai/run - Write
Run a Workers AI model
Runs the Workers AI model specified in the URL path. Send the model's inputs directly in the request body, without a model/input/options wrapper. Accepts model-specific JSON or binary input. The response format depends on the model and the requested output. See the [model catalog](https://developers.cloudflare.com/workers-ai/models/) for supported models and their input formats.
POST /accounts/{account_id}/ai/run/{model_name} - Write
Convert uploaded files to Markdown
Converts files uploaded as multipart form data into Markdown using Workers AI. Returns a conversion result for each file. Use the supported-formats endpoint to check accepted file types.
POST /accounts/{account_id}/ai/tomarkdown
Workers AI Finetune
- Read
List Finetunes
Lists all fine-tuning jobs created by the account, including status and metrics.
GET /accounts/{account_id}/ai/finetunes - Read
List Public Finetunes
Lists publicly available fine-tuned models that can be used with Workers AI.
GET /accounts/{account_id}/ai/finetunes/public - Write
Create a new Finetune
Creates a new fine-tuning job for a Workers AI model using custom training data.
POST /accounts/{account_id}/ai/finetunes - Write
Upload a Finetune Asset
Uploads training data assets for a Workers AI fine-tuning job.
POST /accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets - Destructive
Delete a Finetune
Delete a finetune. Any in-flight requests referencing the lora will fail after the files are deleted.
DELETE /accounts/{account_id}/ai/finetunes/{finetune_id}
Finetune Asset
- Read
Download a Finetune Asset
Returns a pre-signed R2 URL for downloading a finetune asset file.
GET /accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets/{file_name}
Notification Alert Types
- Read
Get Alert Types
Gets a list of all alert types for which an account is eligible.
GET /accounts/{account_id}/alerting/v3/available_alerts
Notification Mechanism Eligibility
- Read
Get delivery mechanism eligibility
Get a list of all delivery mechanism types for which an account is eligible.
GET /accounts/{account_id}/alerting/v3/destinations/eligible
Notification destinations with Pager Duty
- Read
List PagerDuty services
Get a list of all configured PagerDuty services.
GET /accounts/{account_id}/alerting/v3/destinations/pagerduty - Read
Connect PagerDuty
Links PagerDuty with the account using the integration token.
GET /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id} - Write
Create PagerDuty integration token
Creates a new token for integrating with PagerDuty.
POST /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect - Destructive
Delete PagerDuty Services
Deletes all the PagerDuty Services connected to the account.
DELETE /accounts/{account_id}/alerting/v3/destinations/pagerduty
Notification webhooks
- Read
List webhooks
Gets a list of all configured webhook destinations.
GET /accounts/{account_id}/alerting/v3/destinations/webhooks - Read
Get a webhook
Get details for a single webhooks destination.
GET /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id} - Write
Create a webhook
Creates a new webhook destination.
POST /accounts/{account_id}/alerting/v3/destinations/webhooks - Destructive
Delete a webhook
Delete a configured webhook destination.
DELETE /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id} - Destructive
Update a webhook
Update a webhook destination.
PUT /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}
Notification History
- Read
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).
GET /accounts/{account_id}/alerting/v3/history
Notification policies
- Read
List Notification policies
Get a list of all Notification policies.
GET /accounts/{account_id}/alerting/v3/policies - Read
Get a Notification policy
Get details for a single policy.
GET /accounts/{account_id}/alerting/v3/policies/{policy_id} - Read
Show email unsubscribe details
Shows details for unsubscribing an email address from a notification policy.
GET /accounts/{account_id}/alerting/v3/policies/{policy_id}/email/unsubscribe - Write
Create a Notification policy
Creates a new Notification policy.
POST /accounts/{account_id}/alerting/v3/policies - Write
Unsubscribe email from a Notification policy
Unsubscribes an email address from a notification policy.
POST /accounts/{account_id}/alerting/v3/policies/{policy_id}/email/unsubscribe - Write
Test a Notification policy
Send a test notification for a policy to verify delivery mechanisms are working as expected.
POST /accounts/{account_id}/alerting/v3/policies/{policy_id}/test - Destructive
Delete a Notification policy
Delete a Notification policy.
DELETE /accounts/{account_id}/alerting/v3/policies/{policy_id} - Destructive
Update a Notification policy
Update a Notification policy.
PUT /accounts/{account_id}/alerting/v3/policies/{policy_id}
Notification Silences
- Read
List Silences
Gets a list of silences for an account.
GET /accounts/{account_id}/alerting/v3/silences - Read
Get Silence
Gets a specific silence for an account.
GET /accounts/{account_id}/alerting/v3/silences/{silence_id} - Write
Create Silences
Creates a new silence for an account.
POST /accounts/{account_id}/alerting/v3/silences - Destructive
Update Silences
Updates existing silences for an account.
PUT /accounts/{account_id}/alerting/v3/silences - Destructive
Delete Silence
Deletes an existing silence for an account.
DELETE /accounts/{account_id}/alerting/v3/silences/{silence_id}
Data Security
- Write
Top integrations by content findings
Returns the top N integrations ranked by total content findings.
POST /accounts/{account_id}/analytics/query/data-security/content-findings/top-n - Write
Data security findings summary
Returns aggregate current-period and previous-period totals for CASB findings.
POST /accounts/{account_id}/analytics/query/data-security/findings/summary - Write
Data security findings timeseries
Returns merged time-bucketed CASB findings.
POST /accounts/{account_id}/analytics/query/data-security/findings/timeseries
ART Analytics
- Read
Query analytics summary
Returns aggregate summary stats for a dataset. Includes current-period and previous-period totals for trend comparison.
POST /accounts/{account_id}/analytics/query/{dataset}/summary - Read
Query analytics 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`).
POST /accounts/{account_id}/analytics/query/{dataset}/timeseries - Read
Query analytics 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.
POST /accounts/{account_id}/analytics/query/{dataset}/top-n
Analytics SQL
- Read
Query analytics datasets
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.
GET /accounts/{account_id}/analytics/sql - Read
Query analytics datasets
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.
POST /accounts/{account_id}/analytics/sql - Read
List available analytics datasets
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.
GET /accounts/{account_id}/analytics/sql/introspection - Read
Query analytics datasets
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.
GET /analytics/sql - Read
Query analytics datasets
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.
POST /analytics/sql - Read
List available analytics datasets
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. The catalogue lists the datasets this deployment is able to describe, which is not a fixed list. Some datasets are described by the service that owns them and are listed only where that service is available, so the same account may see a different catalogue in different environments, and datasets may appear or disappear without a change to this API. Clients should query the catalogue rather than hard-coding it, and should not treat a dataset's absence as proof that it does not exist. Workers Analytics Engine datasets are named by the account that writes them, so they are discovered from that account's own data rather than from a fixed list. They appear as `events.analyticsEngine.<dataset_name>` and differ per account. A dataset is listed for as long as any of its data is retained, so it does not disappear from the catalogue merely because writes have stopped. An account with a very large number of datasets may receive a truncated list. Set `include_wae=false` to omit them. Log Explorer datasets are listed only where the account has them, so they differ per account and are not part of the static catalogue. Set `include_lex=false` to omit them.
GET /analytics/sql/introspection
Analytics Engine
- Read
Execute an Analytics Engine SQL query via query parameter
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.
GET /accounts/{account_id}/analytics_engine/sql - Write
Execute an Analytics Engine SQL query via request body
Executes a SQL query against Workers Analytics Engine data. Pass the SQL query in the request body as plain text. The response uses newline-delimited JSON (NDJSON) by default, or a single JSON object when the query includes a FORMAT JSON clause. Prefer this method for longer queries that may exceed URL length limits.
POST /accounts/{account_id}/analytics_engine/sql
Argo Smart Routing
- Read
Get count of zones with Argo Smart Routing enabled for account
Returns the number of zones that have Argo Smart Routing enabled for the specified account.
GET /accounts/{account_id}/argo/count_zones_enabled - Read
Get count of zones with Argo Smart Routing enabled for user
Returns the number of zones that have Argo Smart Routing enabled for the authenticated user.
GET /user/argo/count_zones_enabled - Read
Get Argo Smart Routing setting
Retrieves the value of Argo Smart Routing enablement setting.
GET /zones/{zone_id}/argo/smart_routing - Write
Patch Argo Smart Routing setting
Configures the value of the Argo Smart Routing enablement setting.
PATCH /zones/{zone_id}/argo/smart_routing
Artifacts
- Read
List namespaces
Lists Artifacts namespaces for an account.
GET /accounts/{account_id}/artifacts/namespaces - Read
Get a namespace
Returns an Artifacts namespace summary.
GET /accounts/{account_id}/artifacts/namespaces/{namespace} - Read
List repositories
Lists repositories in a namespace.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos - Read
Get a repository
Returns repository metadata.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name} - Read
Read a Git blob
Returns raw bytes for an immutable Git blob object. Blob responses are cacheable forever by hash.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/blob/{hash} - Read
Read a Git commit
Returns decoded metadata for an immutable Git commit object. Commit responses are cacheable forever by hash.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/commit/{hash} - Read
Read a file
Returns raw bytes for a file resolved by ref and path.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/file - Read
Read commit history
Returns commit metadata walking backwards from a ref, branch, tag, or HEAD.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/log - Read
Read a raw file with content type
Returns file bytes resolved by ref and path, with a sniffed content type and browser-safe response headers.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/raw/{ref}/{path} - Read
List repository tokens
Lists tokens for a repository.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/tokens - Read
Read a Git tree
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.
GET /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/tree/{hash} - Write
Create a namespace
Creates an empty Artifacts namespace for an account.
POST /accounts/{account_id}/artifacts/namespaces - Write
Create a repository
Creates a Git-compatible Artifacts repository in a namespace.
POST /accounts/{account_id}/artifacts/namespaces/{namespace}/repos - Write
Fork a repository
Forks a source repository into a new repository.
POST /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/fork - Write
Import a repository
Imports an HTTPS Git repository into an Artifacts repository.
POST /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name}/import - Write
Create a repository token
Creates a scoped Git token for a repository.
POST /accounts/{account_id}/artifacts/namespaces/{namespace}/tokens - Destructive
Delete a namespace
Deletes an empty Artifacts namespace.
DELETE /accounts/{account_id}/artifacts/namespaces/{namespace} - Destructive
Delete a repository
Deletes a repository and schedules cleanup of its backing data.
DELETE /accounts/{account_id}/artifacts/namespaces/{namespace}/repos/{name} - Destructive
Revoke a token
Revokes an Artifacts repository token. Token IDs are resolved through an eventually consistent index, so revoking a token within about a second of creating it can return 404; retry after a short delay.
DELETE /accounts/{account_id}/artifacts/namespaces/{namespace}/tokens/{id}
Audit Logs
- Read
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.
GET /accounts/{account_id}/audit_logs - Read
Get account audit logs (Version 2)
Gets a list of audit logs for an account.
GET /accounts/{account_id}/logs/audit - Read
List account audit log product categories (Version 2)
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.
GET /accounts/{account_id}/logs/audit/product_categories - Read
Get resource change history from an account audit log entry (Version 2)
Returns the chronological change history for the resource identified by the given audit log entry. The endpoint first locates the source audit log entry by `id` (using `action_time` to narrow the lookup window), derives identifying filters from that entry, and then returns matching audit logs within the `since`/`before` window. The `result_info.history_status` field indicates the quality of the resource identification used: - `exact`: Resource was identified by the resource URI. - `approximate`: Resource was identified without the resource URI. - `unavailable`: The source audit log entry did not contain enough information to identify the resource; an empty result is returned.
GET /accounts/{account_id}/logs/audit/{id}/history - Read
Get organization audit logs (Version 2)
Gets a list of audit logs for an organization.
GET /organizations/{organization_id}/logs/audit - Read
Get resource change history from an organization audit log entry (Version 2)
Returns the chronological change history for the resource identified by the given organization-scoped audit log entry. The endpoint first locates the source audit log entry by `id` (using `action_time` to narrow the lookup window), derives identifying filters from that entry, and then returns matching audit logs within the `since`/`before` window. The `result_info.history_status` field indicates the quality of the resource identification used: - `exact`: Resource was identified by the resource URI. - `approximate`: Resource was identified without the resource URI. - `unavailable`: The source audit log entry did not contain enough information to identify the resource; an empty result is returned.
GET /organizations/{organization_id}/logs/audit/{id}/history - Read
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.
GET /user/audit_logs
Auto RAG RAG Search
- Read
Search
Searches an AutoRAG.
POST /accounts/{account_id}/autorag/rags/{id}/search - Write
AI Search
Runs an AI Search query against an AutoRAG.
POST /accounts/{account_id}/autorag/rags/{id}/ai-search
Auto RAG RAG
- Read
Files
Lists files indexed by an AutoRAG.
GET /accounts/{account_id}/autorag/rags/{id}/files - Write
Sync
Starts synchronization for an AutoRAG.
PATCH /accounts/{account_id}/autorag/rags/{id}/sync
Auto RAG Jobs
- Read
List Jobs
Lists jobs for an AutoRAG.
GET /accounts/{account_id}/autorag/rags/{id}/jobs - Read
Get a Job Details
Returns details for an AutoRAG job.
GET /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id} - Read
List Job Logs
Lists logs for an AutoRAG job.
GET /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}/logs
Basin Catalog Management
- Read
List Basin 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.
GET /accounts/{account_id}/basin-catalog - Read
Get Basin Catalog details
Retrieve detailed information about a specific Basin Catalog by bucket name. Returns catalog status, maintenance configuration, and credential status.
GET /accounts/{account_id}/basin-catalog/{bucket_name} - Write
Disable Basin 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.
POST /accounts/{account_id}/basin-catalog/{bucket_name}/disable - Write
Enable R2 bucket as a 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.
POST /accounts/{account_id}/basin-catalog/{bucket_name}/enable - Destructive
Delete Basin Catalog metadata
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.
POST /accounts/{account_id}/basin-catalog/{bucket_name}/delete
Credential Management
- Read
Get Basin Catalog credential status
Check whether the configured catalog credentials are valid, invalid, or absent by probing authentication against the catalog.
GET /accounts/{account_id}/basin-catalog/{bucket_name}/credential/status - Read
Get catalog credential status (deprecated)
Check whether the configured catalog credentials are valid, invalid, or absent by probing authentication against the catalog.
GET /accounts/{account_id}/r2-catalog/{bucket_name}/credential/status - Write
Store catalog credentials
Store authentication credentials for a catalog. These credentials are used to authenticate with R2 storage when performing catalog operations.
POST /accounts/{account_id}/basin-catalog/{bucket_name}/credential - Write
Store catalog credentials (deprecated)
Store authentication credentials for a catalog. These credentials are used to authenticate with R2 storage when performing catalog operations.
POST /accounts/{account_id}/r2-catalog/{bucket_name}/credential
Maintenance Configuration
- Read
Get catalog maintenance configuration
Retrieve the maintenance configuration for a specific catalog, including compaction settings and credential status.
GET /accounts/{account_id}/basin-catalog/{bucket_name}/maintenance-configs - Read
Get catalog maintenance configuration (deprecated)
Retrieve the maintenance configuration for a specific catalog, including compaction settings and credential status.
GET /accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs - Write
Update catalog maintenance configuration
Update the maintenance configuration for a catalog. This allows you to enable or disable compaction and adjust target file sizes for optimization.
POST /accounts/{account_id}/basin-catalog/{bucket_name}/maintenance-configs - Write
Update catalog maintenance configuration (deprecated)
Update the maintenance configuration for a catalog. This allows you to enable or disable compaction and adjust target file sizes for optimization.
POST /accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs
Namespace Management
- Read
List namespaces in catalog
Returns a list of namespaces in the specified Basin Catalog. Supports hierarchical filtering and pagination for efficient traversal of large namespace hierarchies.
GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces - Read
List namespaces in catalog (deprecated)
Returns a list of namespaces in the specified R2 catalog. Supports hierarchical filtering and pagination for efficient traversal of large namespace hierarchies.
GET /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces
Table Management
- Read
List tables in namespace
Returns a list of tables in the specified namespace within a Basin Catalog. Supports pagination for efficient traversal of large table collections.
GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables - Read
Get table details
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. The `metadata.snapshots`, `metadata.snapshot-log`, and `metadata.metadata-log` arrays are pruned to the most recent 10 entries by `timestamp-ms`. Use `total_snapshots` and `returned_snapshots` to surface the truncation to end users.
GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name} - Read
List tables in namespace (deprecated)
Returns a list of tables in the specified namespace within an R2 catalog. Supports pagination for efficient traversal of large table collections.
GET /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables - Read
Get table details (deprecated)
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. The `metadata.snapshots`, `metadata.snapshot-log`, and `metadata.metadata-log` arrays are pruned to the most recent 10 entries by `timestamp-ms`. Use `total_snapshots` and `returned_snapshots` to surface the truncation to end users.
GET /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}
Table Maintenance Configuration
- Read
Get table maintenance configuration
Retrieve the maintenance configuration for a specific table, including compaction settings.
GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs - Read
List table maintenance runs
Retrieves recent table maintenance runs for the current table.
GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-runs - Read
Get table maintenance configuration (deprecated)
Retrieve the maintenance configuration for a specific table, including compaction settings.
GET /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs - Read
List table maintenance runs (deprecated)
Retrieves recent table maintenance runs for the current table.
GET /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-runs - Write
Update table maintenance configuration
Update the maintenance configuration for a specific table. This allows you to enable or disable compaction and adjust target file sizes for optimization.
POST /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs - Write
Queue table maintenance
Queue maintenance for normal polling. This request does not start a run.
POST /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs/{configuration_type}/queue - Write
Update table maintenance configuration (deprecated)
Update the maintenance configuration for a specific table. This allows you to enable or disable compaction and adjust target file sizes for optimization.
POST /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs - Write
Queue table maintenance (deprecated)
Queue maintenance for normal polling. This request does not start a run.
POST /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs/{configuration_type}/queue
Billable Usage
- Read
Get Account Billable Usage (Version 1, Alpha)
Returns billable usage data for the account. When no query parameters are provided, returns usage for the current billing period.
GET /accounts/{account_id}/billable-usage - Read
Get Account Billable Usage Info (Version 1, Alpha)
Returns high-level usage information for the account, including coverage, and subscription metadata.
GET /accounts/{account_id}/billable-usage/info
Billable Usage V2
- Read
Get Account Usage (Version 2, Alpha, Restricted)
Returns cost and usage data for a single Cloudflare account, aligned with the [FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and Usage dataset specification. Each record represents one billable metric for one account on one day. This includes all metered usage, including usage that falls within free-tier allowances and may result in zero cost. **Note:** This endpoint serves `usage` records only; cost and pricing fields are absent from responses. To retrieve rated costs, use `POST` on the same path with `Metric: cost`. When `from` and `to` are omitted, defaults to the start of the current month through today. The maximum date range is 31 days.
GET /accounts/{account_id}/billable/usage - Read
Query Account Usage (Version 2, Alpha, Restricted)
Returns cost and usage data for a single Cloudflare account, aligned with the [FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and Usage dataset specification. This is the filterable counterpart to `GET` on the same path. It is a read-only operation and requires only the `#billing:read` permission; `POST` is used so that filter criteria can be supplied in a request body rather than in the query string. Each record represents one billable metric for one account on one day. This includes all metered usage, including usage that falls within free-tier allowances and may result in zero cost. **Note:** Cost and pricing fields are populated only when `Metric` is `cost`; otherwise they are absent from responses. The request body is optional. When it is omitted, or when `TimePeriod` is omitted, the range defaults to the start of the current month through today. The maximum date range is 31 days. Filters of different kinds are combined with AND. Values within one tag filter are combined with OR. Filter values that do not match usage produce an empty result set. Results can be grouped by up to two groups, in any combination of dimension keys and resource-tag keys. Tag groups are returned in the `Tags` field. Usage without a requested tag remains in an untagged group, with that key omitted from `Tags`. Requests that use tag filtering or tag grouping return HTTP 400 when the underlying usage data source does not support tags. Requests that use dimension grouping return HTTP 400 when the underlying usage data source does not support dimensions.
POST /accounts/{account_id}/billable/usage - Read
List Account Billable Metrics (Version 2, Alpha, Restricted)
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. When `from` and `to` are omitted, the period defaults to the start of the current month through today. The maximum date range is 31 days.
GET /accounts/{account_id}/billable/usage/billable-metrics - Read
Get Organization Usage (Version 2, Alpha, Restricted)
Returns cost and usage data for all accounts within an organization, aligned with the [FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and Usage dataset specification. Each record represents one billable metric for one account on one day. This includes all metered usage, including usage that falls within free-tier allowances and may result in zero cost. The response includes usage for every account belonging to the specified organization. **Note:** This endpoint serves `usage` records only; cost and pricing fields are absent from responses. Rated costs are available per account via `POST /accounts/{account_id}/billable/usage` with `Metric: cost`. When `from` and `to` are omitted, defaults to the start of the current month through today. The maximum date range is 31 days. An organization with no accounts, or an organization ID that does not exist, returns a successful response with an empty result set rather than an error.
GET /organizations/{organization_id}/billable/usage
Account Billing
- Read
Get Account Bad Debt
Gets bad debt information for an account, including outstanding invoices and total debt amount.
GET /accounts/{account_id}/billing/bad-debt - Read
Get Account Credits
Gets the credit balance and eligibility for an account.
GET /accounts/{account_id}/billing/credits - Read
Get Unpaid Invoices
Gets unpaid invoice information for an account.
GET /accounts/{account_id}/billing/unpaid-invoice - Read
Get Receipt PDF
Downloads a receipt as a PDF document.
GET /accounts/{account_id}/receipts/{receipt_id}/pdf - Read
Validate Billing 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.
POST /billing/address-validation - Write
Create Payment Intent for Billing Profile
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.
POST /accounts/{account_id}/billing/profile/payment-method - Write
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.
POST /accounts/{account_id}/client-secret - Write
Toggle PDF Invoices
Toggles PDF invoice generation for an account.
PATCH /accounts/{account_id}/invoices - Write
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.
POST /accounts/{account_id}/pay-invoice
Account Billing History
- Read
Get Account Billing History
Gets the billing history for an account.
GET /accounts/{account_id}/billing/history
Account Billing Profile
- Read
Get Billing Profile
Gets the current billing profile for the account.
GET /accounts/{account_id}/billing/profile - Write
Update Billing Email
Updates the billing email addresses and preferred locale for an account.
PATCH /accounts/{account_id}/billing/profile - Write
Create Billing Profile
Creates a billing profile for an account.
POST /accounts/{account_id}/billing/profile - Destructive
Delete Billing Profile
Deletes the billing profile for an account.
DELETE /accounts/{account_id}/billing/profile - Destructive
Update Billing Profile
Updates the billing profile for an account.
PUT /accounts/{account_id}/billing/profile
Spend Policies
- Read
List Spend Policies
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.
GET /accounts/{account_id}/billing/spend-policies - Read
List Spend Policy 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.
GET /accounts/{account_id}/billing/spend-policies/activity - Read
Get Spend Policy
Returns one spend policy. The `ETag` response header holds the current `version`; send it as `If-Match` on a later update or delete.
GET /accounts/{account_id}/billing/spend-policies/{policy_id} - Read
List Spend Policy Audit Entries
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.
GET /accounts/{account_id}/billing/spend-policies/{policy_id}/audit - Write
Create Spend Policy
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.
POST /accounts/{account_id}/billing/spend-policies - Destructive
Delete Spend Policy
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`.
DELETE /accounts/{account_id}/billing/spend-policies/{policy_id} - Destructive
Update Spend Policy
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`.
PUT /accounts/{account_id}/billing/spend-policies/{policy_id}
Usage Analytics
- Read
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.
GET /accounts/{account_id}/billing/usage - Read
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.
GET /accounts/{account_id}/media/usage - Read
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.
GET /accounts/{account_id}/stream/usage - Read
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.
GET /zones/{zone_id}/media/usage - Read
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.
GET /zones/{zone_id}/stream/usage
Botnet Threat Feed
- Read
Get daily 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.
GET /accounts/{account_id}/botnet_feed/asn/{asn_id}/day_report - Read
Get full report
Gets all the data the botnet threat feed tracking database has for a given ASN registered to user account.
GET /accounts/{account_id}/botnet_feed/asn/{asn_id}/full_report - Read
Get list of ASNs
Gets a list of all ASNs registered for a user for the DDoS Botnet Feed API.
GET /accounts/{account_id}/botnet_feed/configs/asn - Destructive
Delete an ASN
Delete an ASN from botnet threat feed for a given user.
DELETE /accounts/{account_id}/botnet_feed/configs/asn/{asn_id}
Brand protection
- Read
Read all alerts on submitted domains
Return all alerts on submitted domains.
GET /accounts/{account_id}/brand-protection/alerts - Read
Read all brands
Return all brands.
GET /accounts/{account_id}/brand-protection/brands - Read
Read patterns for brands by ID
Return patterns for brands based on ID.
GET /accounts/{account_id}/brand-protection/brands/patterns - Read
Read submitted domains by ID
Return submitted domains based on ID.
GET /accounts/{account_id}/brand-protection/domain-info - Read
Read recent URL submissions
Return recent URL submissions.
GET /accounts/{account_id}/brand-protection/recent-submissions - Read
Read URL submissions by ID
Return URL submissions based on ID.
GET /accounts/{account_id}/brand-protection/submission-info - Read
Read submitted domains by pattern
Return submitted domains based on pattern.
GET /accounts/{account_id}/brand-protection/tracked-domains - Read
Read submitted URLs by ID
Return submitted URLs based on ID.
GET /accounts/{account_id}/brand-protection/url-info - Read
Run liveness checks
Return a success message after running liveness checks.
GET /live - Read
Run readiness checks
Return a success message after running readiness checks.
GET /ready - Write
Update alerts on submitted domains by ID
Return a success message after updating alerts on submitted domains by ID.
PATCH /accounts/{account_id}/brand-protection/alerts - Write
Update verification statuses of tracked URLs to awaiting by ID
Return a success message after updating verification statuses of tracked URLs to awaiting by ID.
PATCH /accounts/{account_id}/brand-protection/alerts/clear - Write
Update verification statuses of tracked URLs to disproven by ID
Return a success message after updating verification statuses of tracked URLs to disproven by ID.
PATCH /accounts/{account_id}/brand-protection/alerts/refute - Write
Update verification statuses of tracked URLs to confirmed by ID
Return a success message after updating verification statuses of tracked URLs to confirmed by ID.
PATCH /accounts/{account_id}/brand-protection/alerts/verify - Write
Create new brands
Return new brands.
POST /accounts/{account_id}/brand-protection/brands - Write
Create new patterns for brands by ID
Return a success message after creating new patterns for brands by ID.
POST /accounts/{account_id}/brand-protection/brands/patterns - Write
Update verification statuses of submitted URLs to awaiting by ID
Return a success message after updating verification statuses of submitted URLs to awaiting by ID.
PATCH /accounts/{account_id}/brand-protection/clear - Write
Update verification statuses of submitted URLs to disproven by ID
Return a success message after updating verification statuses of submitted URLs to disproven by ID.
PATCH /accounts/{account_id}/brand-protection/refute - Write
Create new URL submissions
Return new URL submissions.
POST /accounts/{account_id}/brand-protection/submit - Write
Update verification statuses of submitted URLs to confirmed by ID
Return a success message after updating verification statuses of submitted URLs to confirmed by ID.
PATCH /accounts/{account_id}/brand-protection/verify - Write
Internal route for testing URL submissions
Internal route for testing URL submissions.
POST /internal/submit - Destructive
Delete brands by ID
Return a success message after deleting brands by ID.
DELETE /accounts/{account_id}/brand-protection/brands - Destructive
Delete patterns for brands by ID
Return a success message after deleting patterns for brands by ID.
DELETE /accounts/{account_id}/brand-protection/brands/patterns
Logo match
- Read
Read matches for logo queries by ID
Return matches for logo queries based on ID.
GET /accounts/{account_id}/brand-protection/logo-matches - Read
Download matches for logo queries by ID
Return matches as CSV for logo queries based on ID.
GET /accounts/{account_id}/brand-protection/logo-matches/download - Read
Read all saved logo queries
Return all saved logo queries.
GET /accounts/{account_id}/brand-protection/logos - Read
Read saved logo queries by ID
Return saved logo queries based on ID.
GET /accounts/{account_id}/brand-protection/logos/{logo_id} - Read
Internal route for testing signed URLs
Internal route for testing signed URLs.
GET /signed-url - Write
Create new saved logo queries from image files
Return new saved logo queries created from image files.
POST /accounts/{account_id}/brand-protection/logos - Write
Create new logo queries from image files
Return new logo queries created from image files.
POST /accounts/{account_id}/brand-protection/scan-logo - Write
Create new logo queries from URLs
Return new logo queries created from URLs.
POST /accounts/{account_id}/brand-protection/scan-page - Destructive
Delete saved logo queries by ID
Return a success message after deleting saved logo queries by ID.
DELETE /accounts/{account_id}/brand-protection/logos/{logo_id}
Domain search
- Read
Read matches for string queries by ID
Return matches for string queries based on ID.
GET /accounts/{account_id}/brand-protection/matches - Read
Download matches for string queries by ID
Return matches as CSV for string queries based on ID.
GET /accounts/{account_id}/brand-protection/matches/download - Read
Read string queries by ID
Return string queries based on ID.
GET /accounts/{account_id}/brand-protection/queries - Read
Read the total number of saved string queries
Return the total number of saved string queries.
GET /accounts/{account_id}/brand-protection/total-queries - Write
Update saved string queries by ID
Update a saved query's tag, scan setting, or string_matches (pattern). When string_matches is provided, the query parameters and hash are updated. At least one of tag, scan, or string_matches is required.
PATCH /accounts/{account_id}/brand-protection/queries - Write
Create new saved string queries
Return a success message after creating new saved string queries.
POST /accounts/{account_id}/brand-protection/queries - Write
Create new saved string queries in bulk
Return a success message after creating new saved string queries in bulk.
POST /accounts/{account_id}/brand-protection/queries/bulk - Write
Dismiss a match for a saved string query
Hide a matched domain from the default view of a saved query's results. Dismissal is scoped to the calling account.
POST /accounts/{account_id}/brand-protection/queries/{query_id}/matches/{domain_id}/dismiss - Write
Undismiss a match for a saved string query
Restore a previously dismissed matched domain to the default view. Dismissal is scoped to the calling account.
POST /accounts/{account_id}/brand-protection/queries/{query_id}/matches/{domain_id}/undismiss - Write
Create new string queries
Return new string queries.
POST /accounts/{account_id}/brand-protection/search - Destructive
Delete saved string queries by ID
Return a success message after deleting saved string queries by ID.
DELETE /accounts/{account_id}/brand-protection/queries
Browser Extension Config
- Read
Get browser extension configuration
Returns the browser extension configuration for an account.
GET /accounts/{account_id}/browser-extension/config - Read
Search browser extension event logs
Searches browser extension event logs for an account. The request accepts only supported fields and filters; raw SQL is not accepted.
POST /accounts/{account_id}/browser-extension/config/logs/extension-events/search - Read
Query browser extension event 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.
POST /accounts/{account_id}/browser-extension/config/logs/extension-events/timeseries - Write
Create browser extension configuration
Creates the browser extension configuration for an account.
POST /accounts/{account_id}/browser-extension/config - Destructive
Delete browser extension configuration
Deletes the browser extension configuration for an account. The shard mapping is preserved and not deleted.
DELETE /accounts/{account_id}/browser-extension/config - Destructive
Update browser extension configuration
Replaces the browser extension configuration for an account. The configuration must already exist. The shard mapping is immutable.
PUT /accounts/{account_id}/browser-extension/config
Browser Extension Inventories
- Read
List browser extension inventories
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. Results are paginated by cursor. Pass the `cursor` from a previous response to fetch the next page. `per_page` controls page size (default 50, max 200).
GET /accounts/{account_id}/browser-extension/config/inventories - Read
Get a single browser extension inventory
Returns the installed extension inventory for a single registered browser extension device.
GET /accounts/{account_id}/browser-extension/config/inventories/{registration_id}
Brapi
- Read
Get accessibility tree page
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.
POST /accounts/{account_id}/browser-rendering/accessibilityTree - Read
Get HTML content.
Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
POST /accounts/{account_id}/browser-rendering/content - Read
Get crawl result.
Returns the result of a crawl job.
GET /accounts/{account_id}/browser-rendering/crawl/{job_id} - Read
Get a browser session ID.
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.
POST /accounts/{account_id}/browser-rendering/devtools/browser - Read
List targets.
Returns a list of all debuggable targets including tabs, pages, service workers, and other browser contexts.
GET /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json - Read
List targets.
Returns a list of all debuggable targets including tabs, pages, service workers, and other browser contexts.
GET /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list - Read
Get a target by ID.
Returns the debuggable target with the given ID.
GET /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list/{target_id} - Read
Get Chrome DevTools Protocol schema.
Returns the complete Chrome DevTools Protocol schema including all domains, commands, events, and types. This schema describes the entire CDP API surface.
GET /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/protocol - Read
Get browser version metadata.
Get browser version metadata.
GET /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/version - Read
List sessions.
List active browser sessions.
GET /accounts/{account_id}/browser-rendering/devtools/session - Read
Get session details.
Get details for a specific browser session.
GET /accounts/{account_id}/browser-rendering/devtools/session/{session_id} - Read
Get 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.
POST /accounts/{account_id}/browser-rendering/json - Read
Get Links.
Get links from a web page.
POST /accounts/{account_id}/browser-rendering/links - Read
Get markdown.
Gets markdown of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options.
POST /accounts/{account_id}/browser-rendering/markdown - Read
Get PDF.
Fetches rendered PDF from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
POST /accounts/{account_id}/browser-rendering/pdf - Read
Get recording data.
Returns the recording data for a given session as a dictionary of events per targetId.
GET /accounts/{account_id}/browser-rendering/recording/{session_id} - Read
Get network recording data.
Returns network recording events for the requested target ID. Use ?format=har for a HAR JSON document.
GET /accounts/{account_id}/browser-rendering/recording/{session_id}/network - Read
Get 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.
POST /accounts/{account_id}/browser-rendering/screenshot - Read
Get HTML content and screenshot.
Returns the page's HTML content and screenshot. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.
POST /accounts/{account_id}/browser-rendering/snapshot - Write
Crawl websites.
Starts a crawl job for the provided URL and its children. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
POST /accounts/{account_id}/browser-rendering/crawl - Write
Activate a browser target.
Activates (brings to front) a specific browser target by its ID.
GET /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/activate/{target_id} - Write
Mint live view URLs for a browser session
Generates time-limited URLs to view a remote browser session. Set `guardrails: { mode: 'readonly' }` to create a view-only link.
POST /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/live_view - Write
Scrape elements.
Get meta attributes like height, width, text and others of selected elements.
POST /accounts/{account_id}/browser-rendering/scrape - Destructive
Cancel a crawl job.
Cancels an ongoing crawl job by setting its status to cancelled and stopping all queued URLs.
DELETE /accounts/{account_id}/browser-rendering/crawl/{job_id} - Destructive
Close browser session.
Closes an existing browser session.
DELETE /accounts/{account_id}/browser-rendering/devtools/browser/{session_id} - Destructive
Close a browser target.
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.
GET /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/close/{target_id} - Destructive
Open a new browser tab.
Opens a new tab in the browser. Optionally specify a URL to navigate to.
PUT /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/new
Builds
- Read
Get builds by Worker version
Retrieve builds associated with one or more Worker version IDs.
GET /accounts/{account_id}/builds/builds - Read
Get latest builds by script IDs
Retrieve the most recent builds for multiple worker scripts
GET /accounts/{account_id}/builds/builds/latest - Read
Get a Workers build
Retrieve status, outcome, timestamps, trigger settings, and source metadata for a build UUID.
GET /accounts/{account_id}/builds/builds/{build_uuid} - Read
Get Workers build logs
Retrieve cursor-paginated log lines for a build UUID.
GET /accounts/{account_id}/builds/builds/{build_uuid}/logs - Destructive
Cancel a Workers build
Cancel a queued or running build.
PUT /accounts/{account_id}/builds/builds/{build_uuid}/cancel
Repository Connections
- Destructive
Create or update a repository connection
Save the repository connection required by build triggers.
PUT /accounts/{account_id}/builds/repos/connections - Destructive
Delete a repository connection
Delete a saved repository connection.
DELETE /accounts/{account_id}/builds/repos/connections/{repo_connection_uuid}
Git Hub Integration
- Read
Get repository configuration autofill
Analyze repository for automatic configuration detection
GET /accounts/{account_id}/builds/repos/{provider_type}/{provider_account_id}/{repo_id}/config_autofill
Build Tokens
- Read
List build tokens
List metadata for build tokens available to the current user without returning their secrets.
GET /accounts/{account_id}/builds/tokens - Write
Create build token
Create a new build authentication token
POST /accounts/{account_id}/builds/tokens - Destructive
Delete a build token
Delete a stored build token owned by the current user.
DELETE /accounts/{account_id}/builds/tokens/{build_token_uuid}
Triggers
- Write
Create a build trigger
Create a trigger defining the repository connection, Worker tag, commands, filters, cache setting, and build token.
POST /accounts/{account_id}/builds/triggers - Write
Update a build trigger
Update commands, cache settings, or branch and path filters for a trigger.
PATCH /accounts/{account_id}/builds/triggers/{trigger_uuid} - Write
Start a Workers build
Start a build for a branch or commit using the selected trigger.
POST /accounts/{account_id}/builds/triggers/{trigger_uuid}/builds - Destructive
Delete a build trigger
Delete a trigger and cancel its unfinished builds.
DELETE /accounts/{account_id}/builds/triggers/{trigger_uuid} - Destructive
Purge a trigger's build cache
Delete cached dependencies and build artifacts associated with a trigger.
POST /accounts/{account_id}/builds/triggers/{trigger_uuid}/purge_build_cache
Environment Variables
- Read
List build variables
List build-time variables configured for a trigger. Secret values are not returned.
GET /accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables - Write
Set build variables
Add or replace build-time variables and secrets without changing unspecified keys.
PATCH /accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables - Destructive
Delete a build variable
Delete one build-time variable or secret by key.
DELETE /accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables/{environment_variable_key}
Workers
- Read
List builds for a Worker
List paginated build records associated with a Worker tag.
GET /accounts/{account_id}/builds/workers/{external_script_id}/builds - Read
List triggers for a Worker
List trigger UUIDs and build settings associated with a Worker tag.
GET /accounts/{account_id}/builds/workers/{external_script_id}/triggers - Read
Get Worker build configuration
Retrieve the repository and production build settings associated with a Worker tag.
GET /accounts/{account_id}/builds/workers/{script_tag} - Read
List previews
List the Previews of a Worker with pagination.
GET /accounts/{account_id}/builds/workers/{script_tag}/previews - Read
Get preview
Retrieve a single Preview of a Worker, including the build settings it currently uses.
GET /accounts/{account_id}/builds/workers/{script_tag}/previews/{preview_id} - Read
List builds by preview
List the builds of a single Preview with pagination.
GET /accounts/{account_id}/builds/workers/{script_tag}/previews/{preview_id}/builds - Read
List Workers
List all Workers for an account.
GET /accounts/{account_id}/workers/workers - Read
Get Worker
Get details about a specific Worker.
GET /accounts/{account_id}/workers/workers/{worker_id} - Write
Create Worker build configuration
Connect a Worker tag to a repository and production build settings.
POST /accounts/{account_id}/builds/workers - Write
Create preview build
Trigger a build for a single Preview.
POST /accounts/{account_id}/builds/workers/{script_tag}/previews/{preview_id}/builds - Write
Create Worker
Create a new Worker.
POST /accounts/{account_id}/workers/workers - Write
Edit Worker
Perform a partial update on a Worker, where omitted properties are left unchanged from their current values.
PATCH /accounts/{account_id}/workers/workers/{worker_id} - Destructive
Delete Worker build configuration
Delete build settings and triggers for a Worker tag and cancel unfinished builds. The Worker is not deleted.
DELETE /accounts/{account_id}/builds/workers/{script_tag} - Destructive
Update Worker build configuration
Update the build configuration for a Worker script. Supports partial updates to git repository settings, production build settings, and Preview settings.
PATCH /accounts/{account_id}/builds/workers/{script_tag} - Destructive
Migrate worker to previews
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.
POST /accounts/{account_id}/builds/workers/{script_tag}/migrate_to_previews - Destructive
Update preview
Update a single Preview of a Worker. Supports partial updates to the tracked branch, the automation flags, and the build settings.
PATCH /accounts/{account_id}/builds/workers/{script_tag}/previews/{preview_id} - Destructive
Delete Worker
Delete a Worker and all its associated resources (versions, deployments, etc.).
DELETE /accounts/{account_id}/workers/workers/{worker_id} - Destructive
Update Worker
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.
PUT /accounts/{account_id}/workers/workers/{worker_id}
Deploy Hooks
- Read
List deploy hooks
List the branch-specific deploy hooks configured for a Worker.
GET /accounts/{account_id}/builds/workers/{script_name}/deploy_hooks - Read
Get a deploy hook
Retrieve the name, branch, Worker identifier, and timestamps for a deploy hook.
GET /accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid} - Write
Create a deploy hook
Create an HTTP hook that starts a build for a selected Worker branch.
POST /accounts/{account_id}/builds/workers/{script_name}/deploy_hooks - Write
Trigger deploy hook
Trigger a build using a deploy hook. This endpoint does not require authentication - the deploy_hook_uuid acts as a secret token.
POST /workers/builds/deploy_hooks/{deploy_hook_uuid} - Destructive
Delete a deploy hook
Delete a deploy hook so its UUID can no longer start builds.
DELETE /accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid} - Destructive
Update a deploy hook
Replace the name and target branch for a deploy hook.
PUT /accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}
Account Subscriptions
- Read
List Subscriptions
Lists all of an account's subscriptions.
GET /accounts/{account_id}/subscriptions - Read
Get Subscription
Gets an account subscription by identifier.
GET /accounts/{account_id}/subscriptions/{subscription_identifier} - Read
Get Cancel Reason
Gets the cancellation reason for an account subscription.
GET /accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason - Write
Create Subscriptions
Creates multiple subscriptions for an account in a single request.
POST /accounts/{account_id}/bulk/subscriptions - Write
Create Subscription
Creates an account subscription.
POST /accounts/{account_id}/subscriptions - Write
Append Subscription Action
Smartly applies the incoming subscription into the lifecycle of the subscription.
POST /accounts/{account_id}/subscriptions/{subscription_identifier}/action/append - Write
Create Cancel Reason
Records a cancellation reason for an account subscription.
POST /accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason - Destructive
Cancel Delayed Downgrade
Cancels pending delayed downgrades for the specified subscriptions.
POST /accounts/{account_id}/subscriptions/cancel-downgrade - Destructive
Delete Subscription
Deletes an account's subscription.
DELETE /accounts/{account_id}/subscriptions/{subscription_identifier} - Destructive
Update Subscription
Updates an account subscription.
PUT /accounts/{account_id}/subscriptions/{subscription_identifier}
Realtime SFU Apps
- Read
List apps
Lists all apps in the Cloudflare account
GET /accounts/{account_id}/calls/apps - Read
Retrieve SFU app details
Fetches details for a single Realtime SFU app.
GET /accounts/{account_id}/calls/apps/{app_id} - Write
Create an SFU app
Creates a Realtime SFU app. An app is an isolated namespace in which sessions can access the app's tracks.
POST /accounts/{account_id}/calls/apps - Destructive
Delete an SFU app
Deletes a Realtime SFU app.
DELETE /accounts/{account_id}/calls/apps/{app_id} - Destructive
Update SFU app details
Updates details for a single Realtime SFU app.
PUT /accounts/{account_id}/calls/apps/{app_id}
Realtime TURN Keys
- Read
List TURN keys
Lists all TURN keys in the Cloudflare account.
GET /accounts/{account_id}/calls/turn_keys - Read
Retrieve TURN key details
Fetches details for a single TURN key.
GET /accounts/{account_id}/calls/turn_keys/{key_id} - Write
Create a TURN key
Creates a new Realtime TURN key.
POST /accounts/{account_id}/calls/turn_keys - Destructive
Delete TURN key
Deletes a Realtime TURN key.
DELETE /accounts/{account_id}/calls/turn_keys/{key_id} - Destructive
Update TURN key details
Updates details for a single TURN key.
PUT /accounts/{account_id}/calls/turn_keys/{key_id}
Cloudflare Tunnel
- Read
List Cloudflare Tunnels
Lists and filters Cloudflare Tunnels in an account.
GET /accounts/{account_id}/cfd_tunnel - Read
Get a Cloudflare Tunnel
Fetches a single Cloudflare Tunnel.
GET /accounts/{account_id}/cfd_tunnel/{tunnel_id} - Read
List Cloudflare Tunnel connections
Lists the connections for a Cloudflare Tunnel, including connector IDs, cloudflared versions, and Cloudflare locations.
GET /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections - Read
Get Cloudflare Tunnel connector
Retrieves a connector and its connection details for a Cloudflare Tunnel, including its cloudflared version, architecture, and connected Cloudflare locations.
GET /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id} - Read
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.
POST /accounts/{account_id}/cfd_tunnel/{tunnel_id}/management - Read
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.
GET /accounts/{account_id}/cfd_tunnel/{tunnel_id}/token - Read
List All Tunnels
Lists and filters all types of Tunnels in an account.
GET /accounts/{account_id}/tunnels - Read
List Mesh nodes
Lists and filters Mesh nodes in an account.
GET /accounts/{account_id}/warp_connector - Read
Get a Mesh node
Fetches a single Mesh node.
GET /accounts/{account_id}/warp_connector/{tunnel_id} - Read
List Mesh node connections
Lists connection details for a Mesh node.
GET /accounts/{account_id}/warp_connector/{tunnel_id}/connections - Read
Get a Mesh node connector
Fetches connector and connection details for a Mesh node.
GET /accounts/{account_id}/warp_connector/{tunnel_id}/connectors/{connector_id} - Read
Get a Mesh node token
Gets the token used to associate a WARP device with a specific Mesh node.
GET /accounts/{account_id}/warp_connector/{tunnel_id}/token - Write
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.
POST /accounts/{account_id}/cfd_tunnel - Write
Update a Cloudflare Tunnel
Updates the name or secret of an existing Cloudflare Tunnel.
PATCH /accounts/{account_id}/cfd_tunnel/{tunnel_id} - Write
Create a Mesh node
Creates a new Mesh node in an account.
POST /accounts/{account_id}/warp_connector - Write
Update a Mesh node
Updates an existing Mesh node.
PATCH /accounts/{account_id}/warp_connector/{tunnel_id} - Destructive
Delete a Cloudflare Tunnel
Permanently deletes a Cloudflare Tunnel from an account. The tunnel must have no active connections.
DELETE /accounts/{account_id}/cfd_tunnel/{tunnel_id} - Destructive
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.
DELETE /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections - Destructive
Delete a Mesh node
Deletes a Mesh node from an account.
DELETE /accounts/{account_id}/warp_connector/{tunnel_id} - Destructive
Trigger a manual failover for a Mesh node
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.
PUT /accounts/{account_id}/warp_connector/{tunnel_id}/failover
Cloudflare Tunnel Configuration
- Read
Get Tunnel configuration
Retrieves the configuration for a remotely managed Cloudflare Tunnel.
GET /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations - Read
Get Mesh node HA configuration
Gets the high-availability configuration for a Mesh node.
GET /accounts/{account_id}/warp_connector/{tunnel_id}/configurations - Destructive
Update Tunnel configuration
Replaces the configuration for a remotely managed Cloudflare Tunnel, including its ingress rules and origin request settings.
PUT /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations - Destructive
Update Mesh node HA configuration
Adds or updates the high-availability configuration for a Mesh node.
PUT /accounts/{account_id}/warp_connector/{tunnel_id}/configurations
Turnstile
- Read
List Turnstile Widgets
Lists Turnstile widgets for an account.
GET /accounts/{account_id}/challenges/widgets - Read
Turnstile Widget Details
Returns the configuration of a Turnstile widget.
GET /accounts/{account_id}/challenges/widgets/{sitekey} - Write
Create a Turnstile Widget
Creates a Turnstile widget for an account.
POST /accounts/{account_id}/challenges/widgets - Write
Rotate Secret for a Turnstile Widget
Generates a new secret key for this widget. If `invalidate_immediately` is set to `false`, the previous secret remains valid for 2 hours. Note that secrets cannot be rotated again during the grace period.
POST /accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret - Destructive
Delete a Turnstile Widget
Deletes a Turnstile widget from an account.
DELETE /accounts/{account_id}/challenges/widgets/{sitekey} - Destructive
Update a Turnstile Widget
Updates the configuration of a Turnstile widget.
PUT /accounts/{account_id}/challenges/widgets/{sitekey}
Scans
- Read
Get the Latest Banner Grab Result
Retrieves the latest banner grab results for a Cloudforce One scan configuration, including service banners from open ports.
GET /accounts/{account_id}/cloudforce-one/banner/{config_id} - Read
List Scan Configs
Lists scan configurations for Cloudforce One's network scanning service.
GET /accounts/{account_id}/cloudforce-one/scans/config - Read
Get the Latest Scan Result
Retrieves the latest scan results for a Cloudforce One scan configuration, including discovered open ports.
GET /accounts/{account_id}/cloudforce-one/scans/results/{config_id} - Read
List scans
Returns all scans for the account.
GET /accounts/{account_id}/vuln_scanner/scans - Read
Get scan
Returns a single scan by ID.
GET /accounts/{account_id}/vuln_scanner/scans/{scan_id} - Write
Create a new Scan Config
Creates a new scan configuration for Cloudforce One's network scanning service.
POST /accounts/{account_id}/cloudforce-one/scans/config - Write
Update an existing Scan Config
Updates an existing scan configuration in Cloudforce One's network scanning service.
PATCH /accounts/{account_id}/cloudforce-one/scans/config/{config_id} - Write
Create scan
Creates and starts a new vulnerability scan. The response may include non-fatal warnings in the `messages` array.
POST /accounts/{account_id}/vuln_scanner/scans - Destructive
Delete a Scan Config
Deletes a scan configuration from Cloudforce One's network scanning service.
DELETE /accounts/{account_id}/cloudforce-one/scans/config/{config_id} - Destructive
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`.
DELETE /accounts/{account_id}/vuln_scanner/scans/{scan_id}
Bin DB
- Read
Retrieves a file from Binary Storage
Retrieves a binary file from the Cloudforce One binary storage for analysis.
GET /accounts/{account_id}/cloudforce-one/binary/{hash} - Write
Posts a file to Binary Storage
Uploads a binary file to Cloudforce One's binary database for malware analysis and threat intelligence correlation.
POST /accounts/{account_id}/cloudforce-one/binary
Event
- Read
List events
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`.
GET /accounts/{account_id}/cloudforce-one/events - Read
Search events
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.
POST /accounts/{account_id}/cloudforce-one/events - Read
Aggregate events
Counts events grouped by one or more columns, such as `attacker` or `targetIndustry`. Optionally filter by date range and group the counts by day.
GET /accounts/{account_id}/cloudforce-one/events/aggregate - Read
List related events
Lists events related to an event by following its relationships. `datasetId` is required. Use `direction`, `maxDepth`, and `relationshipTypes` to control which relationships are followed.
GET /accounts/{account_id}/cloudforce-one/events/by-id/{event_id}/relationships - Read
Get an event
Returns an event from a dataset by its UUID.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/events/{event_id} - Read
Get raw data for an event
Returns the raw source data stored with an event.
GET /accounts/{account_id}/cloudforce-one/events/datasets/{dataset_id}/events/{event_id}/raw - Read
List saved event queries
Lists the account's saved event queries.
GET /accounts/{account_id}/cloudforce-one/events/queries - Read
Get a saved event query
Returns a saved event query by its ID.
GET /accounts/{account_id}/cloudforce-one/events/queries/{query_id} - Read
Get raw data for an event (legacy) (deprecated)
Legacy. Use `threat-intel events raw get` (`GET /events/datasets/{dataset_id}/events/{event_id}/raw`) instead. Available through 2026-11-28.
GET /accounts/{account_id}/cloudforce-one/events/raw/{dataset_id}/{event_id} - Read
Get an event (legacy) (deprecated)
Legacy. Use `threat-intel events get` (`GET /events/dataset/{dataset_id}/events/{event_id}`) instead.
GET /accounts/{account_id}/cloudforce-one/events/{event_id} - Read
Get raw event data by raw ID (legacy)
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.
GET /accounts/{account_id}/cloudforce-one/events/{event_id}/raw/{raw_id} - Read
List related events (legacy) (deprecated)
Legacy. Use `threat-intel events relationships list` (`GET /events/by-id/{event_id}/relationships`) instead. Available through 2026-11-28.
GET /accounts/{account_id}/cloudforce-one/events/{event_id}/relationships - Write
Create an event
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`.
POST /accounts/{account_id}/cloudforce-one/events/create - Write
Create events in bulk
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.
POST /accounts/{account_id}/cloudforce-one/events/create/bulk - Write
Create events with relationships in bulk (legacy) (deprecated)
Legacy. Use `threat-intel events bulk-create` (`POST /events/create/bulk`) and `threat-intel events relationships create` (`POST /events/relationships/create`) instead.
POST /accounts/{account_id}/cloudforce-one/events/create/bulk/relationships - Write
Copy events to another dataset
Copies events to the dataset given by `destDatasetId` and leaves the originals in place. Raw event data is copied only when `keepRawData` is true.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/copy - Write
Add tags to an event (legacy)
Legacy. Use `threat-intel tags relationships create` (`POST /events/tags/{tag_uuid}/relationships`) instead.
POST /accounts/{account_id}/cloudforce-one/events/event_tag/{event_id}/create - Write
Run a GraphQL aggregation over events
Runs a GraphQL aggregation query over events. Supports grouping by multiple fields, date range filters, and aggregation across datasets.
POST /accounts/{account_id}/cloudforce-one/events/graphql - Write
Create a saved event query
Saves an event query under a unique `name`. `query_json` holds the query parameters as a JSON string.
POST /accounts/{account_id}/cloudforce-one/events/queries/create - Write
Update a saved event query
Updates the given fields of a saved event query.
PATCH /accounts/{account_id}/cloudforce-one/events/queries/{query_id} - Write
Update a saved event query
Updates the given fields of a saved event query.
POST /accounts/{account_id}/cloudforce-one/events/queries/{query_id} - Write
Add event references (legacy)
Legacy. Use `threat-intel events relationships create` (`POST /events/relationships/create`) instead.
POST /accounts/{account_id}/cloudforce-one/events/relate/{event_id}/create - Write
Create event relationships
Creates directed relationships of type `relationshipType` from a parent event to one or more child events in the same dataset.
POST /accounts/{account_id}/cloudforce-one/events/relationships/create - Write
Update events in bulk
Applies the same field values to up to 100 events in one dataset. The `date` field can't be changed in bulk.
PATCH /accounts/{account_id}/cloudforce-one/events/update/bulk - Write
Update an event
Updates the given fields of an event and leaves the other fields unchanged. `datasetId` is required.
PATCH /accounts/{account_id}/cloudforce-one/events/{event_id} - Write
Update an event
Updates the given fields of an event and leaves the other fields unchanged. `datasetId` is required.
POST /accounts/{account_id}/cloudforce-one/events/{event_id} - Write
Update raw event data by raw ID (legacy)
Legacy. Updates raw data stored under a `raw_id`, which new events don't use. There is no direct replacement.
PATCH /accounts/{account_id}/cloudforce-one/events/{event_id}/raw/{raw_id} - Write
Update raw event data by raw ID (legacy)
Legacy. Updates raw data stored under a `raw_id`, which new events don't use. There is no direct replacement.
POST /accounts/{account_id}/cloudforce-one/events/{event_id}/raw/{raw_id} - Write
Run a GraphQL aggregation over events (legacy)
Legacy. Use `threat-intel events graphql` (`POST /events/graphql`) instead. Both commands run the same query.
POST /accounts/{account_id}/cloudforce-one/v2/events/graphql - Destructive
Move events to another dataset
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.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/move - Destructive
Delete events
Deletes one or more events from a dataset. Pass the event UUIDs in `eventIds`.
DELETE /accounts/{account_id}/cloudforce-one/events/datasets/{dataset_id}/events - Destructive
Remove tags from an event (legacy)
Legacy. Use `threat-intel tags relationships delete` (`DELETE /events/tags/{tag_uuid}/relationships/{rel_uuid}`) instead.
DELETE /accounts/{account_id}/cloudforce-one/events/event_tag/{event_id} - Destructive
Delete a saved event query
Deletes a saved event query by its ID.
DELETE /accounts/{account_id}/cloudforce-one/events/queries/{query_id} - Destructive
Remove event references (legacy)
Legacy. Removes references created with `threat-intel events legacy references create`. Use `threat-intel events relationships` for new event links.
DELETE /accounts/{account_id}/cloudforce-one/events/relate/{event_id} - Destructive
Delete events (legacy) (deprecated)
Legacy. Use `threat-intel events delete` (`DELETE /events/datasets/{dataset_id}/events`) instead. Available through 2026-11-28.
DELETE /accounts/{account_id}/cloudforce-one/events/{dataset_id}/delete
Attacker
- Read
List attackers
Lists the attackers referenced by events in the datasets given by `datasetIds`, or in the default dataset when `datasetIds` is omitted.
GET /accounts/{account_id}/cloudforce-one/events/attackers
Category
- Read
List event categories used in datasets
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`.
GET /accounts/{account_id}/cloudforce-one/events/categories - Read
List all event categories
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`.
GET /accounts/{account_id}/cloudforce-one/events/categories/catalog - Read
Get an event category (legacy) (deprecated)
Legacy. Use `threat-intel events categories get` (`GET /events/event-categories/by-id/{category_id}`) instead. Available through 2026-11-28.
GET /accounts/{account_id}/cloudforce-one/events/categories/{category_id} - Read
Get an event category
Returns an event category by its ID.
GET /accounts/{account_id}/cloudforce-one/events/event-categories/by-id/{category_id} - Read
List application categories
List the categories available for classifying applications, ordered by name. Results are paginated by `offset` or `cursor`.
GET /accounts/{account_id}/resource-library/categories - Read
Get application category
Retrieve an application category by its numeric ID.
GET /accounts/{account_id}/resource-library/categories/{id} - Write
Create an event category
Creates an event category for classifying events. `name` and `killChain` are required.
POST /accounts/{account_id}/cloudforce-one/events/categories/create - Write
Update an event category (legacy) (deprecated)
Legacy. Use `threat-intel events categories update` (`PATCH /events/event-categories/by-id/{category_id}`) instead. Available through 2026-11-28.
PATCH /accounts/{account_id}/cloudforce-one/events/categories/{category_id} - Write
Update an event category (legacy) (deprecated)
Legacy. Use `threat-intel events categories update` (`POST /events/event-categories/by-id/{category_id}`) instead. Available through 2026-11-28.
POST /accounts/{account_id}/cloudforce-one/events/categories/{category_id} - Write
Update an event category
Updates the given fields of an event category and leaves the other fields unchanged.
PATCH /accounts/{account_id}/cloudforce-one/events/event-categories/by-id/{category_id} - Write
Update an event category
Updates the given fields of an event category and leaves the other fields unchanged.
POST /accounts/{account_id}/cloudforce-one/events/event-categories/by-id/{category_id} - Destructive
Delete an event category (legacy) (deprecated)
Legacy. Use `threat-intel events categories delete` (`DELETE /events/event-categories/by-id/{category_id}`) instead. Available through 2026-11-28.
DELETE /accounts/{account_id}/cloudforce-one/events/categories/{category_id} - Destructive
Delete an event category
Deletes an event category by its ID.
DELETE /accounts/{account_id}/cloudforce-one/events/event-categories/by-id/{category_id}
Country
- Read
List countries
Lists the countries used in threat intelligence data, such as attacker and target countries.
GET /accounts/{account_id}/cloudforce-one/events/countries
Dataset
- Read
List datasets
Lists the account's datasets. Set `includeDeleted` to include deleted datasets.
GET /accounts/{account_id}/cloudforce-one/events/dataset - Read
Get a dataset
Returns a dataset by its ID.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id} - Write
Create a dataset
Creates a dataset for grouping events. Set `isPublic` to true to let anyone search it; otherwise only the account can.
POST /accounts/{account_id}/cloudforce-one/events/dataset/create - Write
Update a dataset
Updates a dataset's `name` and `isPublic` setting. Both fields are required.
PATCH /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id} - Write
Update a dataset
Updates a dataset's `name` and `isPublic` setting. Both fields are required.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id} - Destructive
Delete a dataset
Deletes a dataset. To see deleted datasets, use `threat-intel datasets list` with `includeDeleted`.
DELETE /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}
Groups
- Read
List account groups
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`.
GET /accounts/{account_id}/cloudforce-one/events/dataset/-/groups - Read
Get an account group
Returns an account group by its ID.
GET /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id} - Read
List group members
Lists the accounts in an account group.
GET /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id}/members - Write
Create an account group
Creates a named group of accounts. To give the group access to a dataset, use `threat-intel datasets access permissions create`.
POST /accounts/{account_id}/cloudforce-one/events/dataset/-/groups - Write
Add an account to a group
Adds an account to an account group. Identify the account by `accountId` or `accountTag`.
POST /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id}/members - Destructive
Delete an account group
Deletes an account group by its ID.
DELETE /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id} - Destructive
Update an account group
Replaces an account group's `name` and `description`.
PUT /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id} - Destructive
Remove an account from a group
Removes an account from an account group.
DELETE /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id}/members/{member_id}
Indicators
- Write
Create an indicator type
Creates an indicator type in a dataset.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicatorTypes/create
Indicator
- Read
List indicators in a dataset (legacy) (deprecated)
Legacy. Use `threat-intel indicators list` (`GET /events/indicators`) instead. It supports multiple datasets and cursor pagination.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators - Read
List tags on a dataset's indicators
Lists the tags applied to indicators in a dataset. Results are not paginated.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/tags - Read
Get an indicator
Returns an indicator by its UUID.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id} - Read
List indicator relationships
Lists the relationships that start at an indicator. Use `search` to filter them and `expand` to include the related entities in the response.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id}/relationships - Read
List indicators
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.
GET /accounts/{account_id}/cloudforce-one/events/indicators - Read
Aggregate indicators by column(s)
Aggregate threat indicators by one or more columns (e.g., indicatorType, value) across datasets. Returns top-N groups ordered by count.
GET /accounts/{account_id}/cloudforce-one/events/indicators/aggregate - Write
Create indicators in bulk
Creates multiple indicators in a dataset in one request. Set `autoCreateType` to create any indicator types that don't exist.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/bulk - Write
Create an indicator
Creates an indicator in a dataset. Set `autoCreateType` to create the indicator type if it doesn't exist.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/create - Write
Update an indicator
Updates the given fields of an indicator and leaves the other fields unchanged.
PATCH /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id} - Write
Create an indicator relationship
Creates a relationship from an indicator to an event or tag (`targetType`). Relationships between two indicators are not supported.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id}/relationships - Destructive
Delete indicators in bulk
Deletes up to 200 indicators from a dataset. Pass the indicator UUIDs in `indicatorIds`; UUIDs that are not found are returned in `missingUUIDs`.
DELETE /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators - Destructive
Delete an indicator
Deletes an indicator by its UUID.
DELETE /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id} - Destructive
Delete an indicator relationship
Deletes an indicator relationship by its UUID. Returns `deleted: false` if the relationship doesn't exist.
DELETE /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id}/relationships/{rel_uuid} - Destructive
Update an indicator relationship
Updates the given fields of an indicator relationship and leaves the other fields unchanged.
PATCH /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id}/relationships/{rel_uuid}
Permissions
- Read
List dataset permissions
Lists the access grants on a dataset.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/permissions - Write
Grant access to a dataset
Gives an account or account group (`subjectType` and `subjectId`) `read` or `write` access to a dataset.
POST /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/permissions - Destructive
Revoke access to a dataset
Removes an access grant from a dataset.
DELETE /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/permissions/{grant_id} - Destructive
Change a dataset permission
Changes the `role` of an access grant to `read` or `write`.
PUT /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/permissions/{grant_id}
Tag
- Read
List indicators related to a tag within a dataset (deprecated) (deprecated)
This endpoint is deprecated. Use GET /:account_id/events/tags/:tag_uuid/indicators with the optional datasetIds query parameter instead. Returns indicators associated with the provided tag UUID within a single dataset's indicator shards, with pagination.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/tags/{tag_uuid}/indicators - Read
List tags
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.
GET /accounts/{account_id}/cloudforce-one/events/tags - Read
List threat actors
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.
GET /accounts/{account_id}/cloudforce-one/events/tags/categories/actors - Read
Get a tag
Returns a tag by its UUID, including its custom fields (`properties`). Tags marked TLP:PURPLE are visible only to Cloudforce One.
GET /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid} - Read
List a tag's indicators
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.
GET /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/indicators - Read
List tag relationships
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.
GET /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/relationships - Write
Create a tag
Creates a tag in the account and returns the complete tag.
POST /accounts/{account_id}/cloudforce-one/events/tags/create - Write
Update a tag
Updates the given fields of a tag and returns the complete tag.
PATCH /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid} - Write
Create a tag relationship
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.
POST /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/relationships - Destructive
Delete a tag
Deletes a tag by its UUID.
DELETE /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid} - Destructive
Delete a tag relationship
Deletes a tag relationship by its UUID. `datasetId` is required. Returns `deleted: false` if the relationship doesn't exist.
DELETE /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/relationships/{rel_uuid} - Destructive
Update a tag relationship
Updates the given fields of a tag relationship and leaves the other fields unchanged. `datasetId` is required.
PATCH /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/relationships/{rel_uuid}
Target Industry
- Read
List target industries in a dataset (legacy)
Legacy. Use `threat-intel events target-industries list` (`GET /events/targetIndustries`) instead.
GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/targetIndustries - Read
List target industries used in datasets
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`.
GET /accounts/{account_id}/cloudforce-one/events/targetIndustries - Read
List all target industries
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`.
GET /accounts/{account_id}/cloudforce-one/events/targetIndustries/catalog
Datasets
- Write
Rebuild dataset lookup lists
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.
POST /accounts/{account_id}/cloudforce-one/events/datasets/populate
Events
- Read
Query graph neighborhood from R2 Data Catalog
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.
GET /accounts/{account_id}/cloudforce-one/events/graph
Indicator Types
- Read
List indicator types
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.
GET /accounts/{account_id}/cloudforce-one/events/indicator-types - Read
List indicator types (legacy) (deprecated)
Legacy. Use `threat-intel indicators types list` (`GET /events/indicator-types`) instead.
GET /accounts/{account_id}/cloudforce-one/events/indicatorTypes
Tag Category
- Read
Get a tag category
Returns a tag category by its UUID, including the custom fields defined in its `schema`.
GET /accounts/{account_id}/cloudforce-one/events/tag-categories/{category_uuid} - Read
List tag categories
Lists the account's tag categories. Use `search` to filter them.
GET /accounts/{account_id}/cloudforce-one/events/tags/categories - Write
Create a tag category
Creates a tag category. Use `schema` to define the custom fields its tags can have.
POST /accounts/{account_id}/cloudforce-one/events/tags/categories/create - Destructive
Delete a tag category
Deletes a tag category by its UUID.
DELETE /accounts/{account_id}/cloudforce-one/events/tag-categories/{category_uuid} - Destructive
Update a tag category
Updates the given fields of a tag category and leaves the other fields unchanged.
PATCH /accounts/{account_id}/cloudforce-one/events/tag-categories/{category_uuid}
TagCategory
- Read
Get a tag category (legacy) (deprecated)
Legacy. Use `threat-intel tags categories get` (`GET /events/tag-categories/{category_uuid}`) instead. Available through 2026-11-28.
GET /accounts/{account_id}/cloudforce-one/events/tags/categories/{category_uuid} - Destructive
Delete a tag category (legacy) (deprecated)
Legacy. Use `threat-intel tags categories delete` (`DELETE /events/tag-categories/{category_uuid}`) instead. Available through 2026-11-28.
DELETE /accounts/{account_id}/cloudforce-one/events/tags/categories/{category_uuid} - Destructive
Update a tag category (legacy) (deprecated)
Legacy. Use `threat-intel tags categories update` (`PATCH /events/tag-categories/{category_uuid}`) instead. Available through 2026-11-28.
PATCH /accounts/{account_id}/cloudforce-one/events/tags/categories/{category_uuid}
Request for Information (RFI)
- Read
List Requests
Lists Cloudforce One intelligence requests with filtering and pagination.
POST /accounts/{account_id}/cloudforce-one/requests - Read
Get Request Priority, Status, and TLP constants
Retrieves constant values used in Cloudforce One requests, including valid statuses and types.
GET /accounts/{account_id}/cloudforce-one/requests/constants - Read
Get Request Quota
Retrieves quota usage for Cloudforce One standard requests.
GET /accounts/{account_id}/cloudforce-one/requests/quota - Read
Get Request Types
Lists available request types for Cloudforce One intelligence requests.
GET /accounts/{account_id}/cloudforce-one/requests/types - Read
Get a Request
Retrieves details for a specific Cloudforce One intelligence request.
GET /accounts/{account_id}/cloudforce-one/requests/{request_id} - Read
List Request Assets
Lists assets attached to a Cloudforce One intelligence request.
POST /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset - Read
Get a Request Asset
Retrieves an asset attached to a Cloudforce One intelligence request.
GET /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id} - Read
List Request Messages
Lists messages in a Cloudforce One intelligence request conversation.
POST /accounts/{account_id}/cloudforce-one/requests/{request_id}/message - Write
Create a New Request.
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.
POST /accounts/{account_id}/cloudforce-one/requests/new - Write
Create a New Request Asset
Uploads a new asset to a Cloudforce One intelligence request.
POST /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/new - Write
Create a New Request Message
Adds a message to a Cloudforce One intelligence request conversation.
POST /accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new - Destructive
Delete a Request
Deletes a Cloudforce One intelligence request and all associated data.
DELETE /accounts/{account_id}/cloudforce-one/requests/{request_id} - Destructive
Update a Request
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.
PUT /accounts/{account_id}/cloudforce-one/requests/{request_id} - Destructive
Delete a Request Asset
Removes an asset from a Cloudforce One intelligence request.
DELETE /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id} - Destructive
Update a Request Asset
Updates an asset in a Cloudforce One intelligence request.
PUT /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id} - Destructive
Delete a Request Message
Removes a message from a Cloudforce One intelligence request thread.
DELETE /accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id} - Destructive
Update a Request Message
Updates a message in a Cloudforce One intelligence request thread.
PUT /accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}
Priority Intelligence Requirements (PIR)
- Read
List Priority Intelligence Requirements
Lists priority intelligence requests in Cloudforce One.
POST /accounts/{account_id}/cloudforce-one/requests/priority - Read
Get Priority Intelligence Requirement Quota
Retrieves quota usage for Cloudforce One priority requests.
GET /accounts/{account_id}/cloudforce-one/requests/priority/quota - Read
Get a Priority Intelligence Requirement
Retrieves a specific priority intelligence request from Cloudforce One.
GET /accounts/{account_id}/cloudforce-one/requests/priority/{priority_id} - Write
Create a New Priority Intelligence Requirement
Creates a new priority intelligence request in Cloudforce One.
POST /accounts/{account_id}/cloudforce-one/requests/priority/new - Destructive
Delete a Priority Intelligence Requirement
Deletes a priority intelligence request from Cloudforce One.
DELETE /accounts/{account_id}/cloudforce-one/requests/priority/{priority_id} - Destructive
Update a Priority Intelligence Requirement
Updates a priority intelligence request in Cloudforce One.
PUT /accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}
Rules
- Read
List rules
Returns all rules for an account with optional filtering.
GET /accounts/{account_id}/cloudforce-one/rules - Read
Get exemption rules for an account
Get all exemption rule patterns for the account, grouped by type.
GET /accounts/{account_id}/cloudforce-one/rules/exemptions - Read
Get managed rules
Get DFP managed rule metadata (name and description) from YARA rules.
GET /accounts/{account_id}/cloudforce-one/rules/managed - Read
Search rules
Search rules using hybrid, vector, keyword, or exact retrieval, backed by AI Search with a SQL fallback.
GET /accounts/{account_id}/cloudforce-one/rules/search - Read
Get dashboard stats
Get statistics about rules for the dashboard.
GET /accounts/{account_id}/cloudforce-one/rules/stats - Read
List email rules
Returns structured email rules.
GET /accounts/{account_id}/cloudforce-one/rules/structured - Read
Get email rule schema
Get the field catalog for structured email rules.
GET /accounts/{account_id}/cloudforce-one/rules/structured/schema - Read
Validate an email rule
Validates structured email rule syntax and metadata.
POST /accounts/{account_id}/cloudforce-one/rules/structured/validate - Read
Get an email rule
Get a structured email rule by ID.
GET /accounts/{account_id}/cloudforce-one/rules/structured/{id} - Read
Get folder tree structure
Get the folder tree structure for rules navigation.
GET /accounts/{account_id}/cloudforce-one/rules/tree - Read
Validate rule with context
Validates rule syntax, name uniqueness, namespace, and metadata.
POST /accounts/{account_id}/cloudforce-one/rules/validate - Read
Get a rule
Get a single rule by ID.
GET /accounts/{account_id}/cloudforce-one/rules/{id} - Write
Create a rule
Create a new detection rule.
POST /accounts/{account_id}/cloudforce-one/rules - Write
Add patterns to exemption rules
Add regex patterns to per-account exemption rules (union semantics). Missing keys leave that type untouched; duplicates are silently deduped.
POST /accounts/{account_id}/cloudforce-one/rules/exemptions - Write
Create an email rule
Create a structured email rule.
POST /accounts/{account_id}/cloudforce-one/rules/structured - Write
Revise and resubmit a rejected structured email rule approval
Validates and compiles a complete structured email rule, then creates an immutable pending revision of its rejected approval.
POST /accounts/{account_id}/cloudforce-one/rules/structured/approvals/{id}/resubmit - Write
Test an email rule
Test a structured email rule against sample email JSON.
POST /accounts/{account_id}/cloudforce-one/rules/structured/{id}/test - Destructive
Delete all rules
Delete all rules in an account.
DELETE /accounts/{account_id}/cloudforce-one/rules - Destructive
Remove patterns from exemption rules
Remove regex patterns from per-account exemption rules. Missing keys leave that type untouched; non-existent patterns are silently skipped.
DELETE /accounts/{account_id}/cloudforce-one/rules/exemptions - Destructive
Update exemption rule patterns
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.
PUT /accounts/{account_id}/cloudforce-one/rules/exemptions - Destructive
Update a pending structured email rule approval
Validate, compile, and replace the proposed structured email rule on a pending approval. Only the original requester may update it.
PUT /accounts/{account_id}/cloudforce-one/rules/structured/approvals/{id} - Destructive
Delete an email rule
Delete an existing structured email rule.
DELETE /accounts/{account_id}/cloudforce-one/rules/structured/{id} - Destructive
Update an email rule
Updates an existing structured email rule.
PUT /accounts/{account_id}/cloudforce-one/rules/structured/{id} - Destructive
Delete a rule
Delete an existing rule.
DELETE /accounts/{account_id}/cloudforce-one/rules/{id} - Destructive
Update a rule
Updates an existing rule.
PUT /accounts/{account_id}/cloudforce-one/rules/{id}
Approvals
- Read
List rule approvals
Returns rule approvals with optional status, revision, reviewer-scope, and mutation-type filtering.
GET /accounts/{account_id}/cloudforce-one/rules/approvals - Read
Get rule approval details
Get a single rule approval with current rule data.
GET /accounts/{account_id}/cloudforce-one/rules/approvals/{id} - Write
Revise and resubmit a rejected approval
Create a new pending revision from a rejected rule approval. Only the original requester may resubmit the latest revision.
POST /accounts/{account_id}/cloudforce-one/rules/approvals/{id}/resubmit - Destructive
Cancel a pending approval
Cancel a pending rule approval. Only its original requester may cancel it.
POST /accounts/{account_id}/cloudforce-one/rules/approvals/{id}/cancel
Brand Protection
- Read
List saved query matches
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.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches - Read
Get queries
Get all saved brand protection queries for an account
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries - Read
List letter templates
List user-defined takedown letter templates. System example templates are available via the /templates/examples endpoint.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates - Read
List example letter templates
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.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates/examples - Read
Get letter template
Get a specific user-defined takedown letter template by ID. System example templates are available via the /templates/examples endpoint.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates/{template_id} - Read
List logo matches
Get paginated list of logo matches for a specific brand protection logo query
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/matches - Read
Get logo queries
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.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries - Read
Search scanned images
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.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/search - Read
List takedown notices
List all takedown notices for the account.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices - Read
Lookup takedown notices by domains
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.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/lookup - Read
Get takedown notice
Get a specific takedown notice by ID.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id} - Read
List takedown letters
List all letters for a specific takedown notice.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters - Read
Get takedown letter
Get a specific takedown letter by ID, including the rendered text.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters/{letter_id} - Read
Download takedown letter PDF
Download the PDF for a stored takedown letter. If no PDF exists yet, it is generated from the stored letter text and cached for future downloads.
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters/{letter_id}/pdf - Read
Get total queries
Get the total number of saved brand protection queries (domain + logo) for an account
GET /accounts/{account_id}/cloudforce-one/v2/brand-protection/total-queries - Write
Bulk dismiss or undismiss matches
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.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches/bulk-dismiss - Write
Insert query
Create a new saved brand protection query with string match patterns
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries - Write
Update domain query
Update a saved brand protection domain query with string match patterns
PATCH /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries/{query_id} - Write
Analyze domains for brand impersonation
Uses AI to scan all domains in the lookback table and identify potential phishing or impersonation attempts against the given brand string.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/trial - Write
Generate takedown letter
Generate a takedown letter from a template. Returns V4 JSON for text format or a PDF binary for pdf format.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/generate - Write
Create letter template
Create a new user-defined takedown letter template
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates - Write
Insert logo query
Create a new saved brand protection logo query for visual similarity matching
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries - Write
Dismiss a match
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.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/queries/{query_id}/matches/{domain_id}/dismiss - Write
Undismiss a match
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.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/queries/{query_id}/matches/{domain_id}/undismiss - Write
Create takedown notice
Create a new takedown notice for a domain suspected of trademark infringement.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices - Write
Create takedown letter
Generate a takedown letter for a notice and persist the rendered text. The PDF is generated lazily on download.
POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters - Destructive
Delete domain query
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.
DELETE /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries/{query_id} - Destructive
Delete letter template
Delete a user-defined takedown letter template. System templates cannot be deleted.
DELETE /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates/{template_id} - Destructive
Update letter template
Update a user-defined takedown letter template. System templates cannot be modified.
PUT /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates/{template_id} - Destructive
Delete logo query
Delete a saved brand protection logo query. Returns 404 if the query ID doesn't exist.
DELETE /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id} - Destructive
Delete takedown notice
Delete a takedown notice and all associated letters. PDFs are also removed from storage.
DELETE /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id} - Destructive
Update takedown notice
Update a takedown notice (e.g. change status to sent, resolved, etc.).
PUT /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id} - Destructive
Delete takedown letter
Delete a specific takedown letter and its associated PDF from storage.
DELETE /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters/{letter_id}
Collections
- Read
List collections
Retrieves all collections for an account with pagination
GET /accounts/{account_id}/cloudforce-one/v2/collections - Read
Get collection
Retrieves a single collection by ID with its schema and metadata
GET /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id} - Read
Export collection to CSV, JSONL, or Markdown
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.
GET /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/export - Read
Query collection items
Retrieves items from a collection with keyset pagination and optional column-based filters
GET /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/items - Read
Get collection item
Retrieve a single item from a collection by its identifier.
GET /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/items/{item_id} - Write
Create a new collection
Creates a collection with four patterns: schema-only (empty collection), rows-only (inferred schema), schema+rows (validated data), or file upload (CSV/JSON/JSONL)
POST /accounts/{account_id}/cloudforce-one/v2/collections - Write
Update collection
Updates collection name and/or metadata. Schema (columns) cannot be modified.
PATCH /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id} - Write
Add column to collection
Adds a new column to an existing collection schema. Existing items will have NULL for the new column unless a default value is provided.
POST /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/columns - Write
Update column
Update name, type, required, or position of a column.
PATCH /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/columns/{column_id} - Write
Update collection item
Update an item in a collection with partial data.
PATCH /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/items/{item_id} - Destructive
Delete collection
Deletes a collection and all its items. This action cannot be undone. The Durable Object storage is deleted asynchronously.
DELETE /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id} - Destructive
Delete column
Delete a column from the collection schema. Data is preserved as orphaned UUID keys (forensic safety) and filtered from API responses.
DELETE /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/columns/{column_id} - Destructive
Delete collection item
Delete an item from a collection by its identifier.
DELETE /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/items/{item_id}
Collections Items
- Read
Search items (advanced filtering)
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.
POST /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/search - Write
Create item(s)
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.
POST /accounts/{account_id}/cloudforce-one/v2/collections/{collection_id}/items
Public Credential Monitor
- Read
List monitored domains
List all domains registered for credential monitoring.
GET /accounts/{account_id}/cloudforce-one/v2/credential-monitor/domains - Read
List credential matches
Get credential matches for the account's monitored domains.
GET /accounts/{account_id}/cloudforce-one/v2/credential-monitor/matches - Write
Create monitored domain
Register a domain for credential monitoring.
POST /accounts/{account_id}/cloudforce-one/v2/credential-monitor/domains - Destructive
Delete monitored domain
Remove a domain from credential monitoring.
DELETE /accounts/{account_id}/cloudforce-one/v2/credential-monitor/domains/{id}
Priority Intelligence Requirements
- Read
List priority intelligence requirements for an account
Lists free-form Priority Intelligence Requirements for the account. Results are scoped to the authenticated account.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence - Read
Get PIR constants (methods, dimensions, and TLP values)
Requirements is the existing free-form PIR method. Interests is the experimental structured-interest method, evaluated independently from requirements.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/constants - Read
List account interests for PIR Option 2
Lists structured account interests for Priority Intelligence Option 2. Filter by enabled state and paginate results.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests - Read
Get a persisted account-interest backtest
Returns a previously completed account-interest backtest by ID. The backtest must belong to this account.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests/backtests/{backtest_id} - Read
Get a persisted account-interest evaluation
Returns a previously completed live account-interest evaluation by ID. The evaluation must belong to this account.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests/evaluations/{evaluation_id} - Read
Count matched events across the account's priority intelligence requirements
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.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/matches/aggregate - Read
Get the organization profile
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.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/profile - Read
Get PIR quota for an account
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.
POST /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/quota - Read
Get a priority intelligence requirement by ID
Returns a single free-form Priority Intelligence Requirement for the authenticated account.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/{priority_id} - Read
List a priority intelligence requirement's matched events
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.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/{priority_id}/matches - Read
Count a priority intelligence requirement's matched events
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.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/{priority_id}/matches/aggregate - Read
Count a priority intelligence requirement's matched events per day
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.
GET /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/{priority_id}/matches/series - Write
Create a priority intelligence requirement
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.
POST /accounts/{account_id}/cloudforce-one/v2/priority-intelligence - Write
Generate event filters from a PIR
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.
POST /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/filters/generate - Write
Create an account interest for PIR Option 2
Creates a structured account interest used by Priority Intelligence Option 2 evaluations. Interests are evaluated independently from free-form PIR requirements.
POST /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests - Write
Backtest account-interest change detection
Uses bounded full-span top-N candidates and daily event-date buckets. Results are conservative rather than an exact historical replay.
POST /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests/backtests - Write
Evaluate recent event-dated changes for account interests
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.
POST /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests/evaluations - Write
Update an account interest for PIR Option 2
Updates a structured account interest used by Priority Intelligence Option 2 evaluations. Changing the value re-resolves the interest against the current catalog.
PATCH /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests/{interest_id} - Write
Triage a priority intelligence requirement's matched events
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.
PATCH /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/{priority_id}/matches - Destructive
Delete an account interest for PIR Option 2
Deletes a structured account interest so later Priority Intelligence Option 2 evaluations no longer include it.
DELETE /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/interests/{interest_id} - Destructive
Delete the organization profile
Deletes the account's organization profile. Succeeds when the account has no profile.
DELETE /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/profile - Destructive
Create or replace the organization profile
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.
PUT /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/profile - Destructive
Delete a priority intelligence requirement
Soft-deletes a PIR. The PIR will no longer count against quota.
DELETE /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/{priority_id} - Destructive
Update a priority intelligence requirement
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.
PUT /accounts/{account_id}/cloudforce-one/v2/priority-intelligence/{priority_id}
Requests Dashboard
- Read
Check if current user is allowlisted for Legal Response
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.
GET /accounts/{account_id}/cloudforce-one/v2/requests/legal-response/access-check - Read
Get request constants
Returns available priorities, statuses, and TLP levels for request workflows
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/constants - Read
List metadata fields for an RFI type
Get custom metadata fields available for the specified project type
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/metadata - Read
Get request token quota
Returns the account's token quota for the current anniversary quarter: total granted, used, remaining, and the quarter/anniversary boundaries.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/quota - Read
List visible request types for a project (dashboard)
Returns request types available to dashboard (external) callers. For restricted project types (e.g. legal-response), only the allowlisted subset is returned.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/types
RFI
- Read
List RFIs
Retrieves a paginated list of RFIs with filtering and sorting options.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type} - Read
Get an RFI by ID
Retrieves a specific RFI by its UUID with related data.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id} - Write
Creates a new RFI
Creates a new Request for Information with the specified project type and details.
POST /accounts/{account_id}/cloudforce-one/v2/requests/{project_type} - Destructive
Update an RFI
Updates an existing RFI with the provided fields. Only provided fields will be updated.
PUT /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}
Dashboard Users
- Read
Get current user profile
Get the current user's profile in a specific RFI project.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/user/me
Dashboard Assets
- Read
List assets in request (Customer)
List all file assets for a request. Customer can only list assets from their own account.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}/assets/list - Read
Download asset (Customer)
Download a file asset from R2 storage. Customer can only download from their own account.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}/assets/{asset_id}/download - Write
Upload asset to request (Customer)
Upload a file asset to R2 storage and associate it with a request. Customer can only upload to their own account.
POST /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}/assets/upload
RFI Messages
- Read
List messages for an RFI request
Retrieves the published, non-deleted messages visible to the agent for an RFI request, with pagination.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}/messages - Read
Read a single message for an RFI request
Returns the details for a specific message belonging to an RFI request.
GET /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}/messages/{message_id} - Write
Create a customer follow-on message on an RFI request
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.
POST /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}/messages/new - Destructive
Update/publish a message for an RFI request
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.
PUT /accounts/{account_id}/cloudforce-one/v2/requests/{project_type}/{request_id}/messages/{message_id}
Threat Intelligence
- Read
Search threat intelligence
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.
POST /accounts/{account_id}/cloudforce-one/v2/search
Threat Signals
- Read
List Threat Signals articles
Lists articles from the account's Threat Signals feeds.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles - Read
Count Threat Signals articles by relevance band
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.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/relevance/aggregate - Read
Count Threat Signals articles by severity band
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.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/severity/aggregate - Read
Get Threat Signals article
Retrieves a Threat Signals article with its summary, tags, indicator status and relevance to the account's Priority Intelligence Requirements.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id} - Read
Get Threat Signals article content
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.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/content - Read
List Threat Signals article custom skills
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.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/skills - Read
Get Threat Signals article skill output
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.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/skills/{skill_id}/output - Read
List Threat Signals feed categories
Lists the predefined categories that can be assigned to feeds.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/categories - Read
List Threat Signals feeds
Lists the account's Threat Signals feed subscriptions.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds - Read
Get Threat Signals feed XML
Retrieves the feed document fetched by the most recent poll as text/plain by default or application/xml when format is xml.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id}/raw - Read
Get Threat Signals feed skills
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.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id}/skills - Read
List Threat Signals article indicators
Lists indicators of compromise extracted from the account's Threat Signals articles.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/indicators - Read
Search Threat Signals articles using AI Search
Searches the account's Threat Signals articles using keyword and semantic retrieval.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/search - Read
List Threat Signals skills
Lists active Managed Default Skills and Custom Skills. Free Threat Signals accounts see active managed defaults only, with custom_skills_available: false.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills - Read
Get Threat Signals skill
Retrieves a Managed Default Skill or Custom Skill. Managed catalog definitions are readable. Free Threat Signals accounts cannot read Custom Skills.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills/{skill_id} - Read
Get Threat Signals skill tag categories
Retrieves the Tag Categories the managed default tagging skill may select tags from. This configures the managed default tagging skill, not Custom Skills.
GET /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills/{skill_id}/tag-categories - Write
Bulk update Threat Signals article read status
Marks up to 50 Threat Signals articles as read or unread.
PATCH /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles - Write
Update Threat Signals article read status
Marks a Threat Signals article as read or unread.
PATCH /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id} - Write
Add tag to Threat Signals article
Applies a tag from the account's tag catalog to a Threat Signals article.
POST /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/tags - Write
Create Threat Signals feed
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.
POST /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds - Write
Trigger Threat Signals feed poll
Starts an immediate poll of one or all Threat Signals feeds.
POST /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/poll - Write
Create Threat Signals skill
Creates a Custom Skill for the account. Free Threat Signals accounts cannot create Custom Skills.
POST /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills - Write
Update Threat Signals skill
Updates a Custom Skill. Managed Default Skills cannot be updated. Free Threat Signals accounts cannot update Custom Skills.
PATCH /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills/{skill_id} - Destructive
Reprocess a Threat Signals article
Synchronously re-runs every processing step for a Threat Signals article: content acquisition, summary, indicator extraction, CVE tags, IOC context, and default tags. 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.
POST /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/reprocess - Destructive
Run and persist skill output for a Threat Signals article
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.
POST /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/skills/{skill_id}/run - Destructive
Generate Threat Signals article AI tags
Runs the default AI tagging skill on an article and replaces its AI-applied tags.
POST /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/tag - Destructive
Remove tag from Threat Signals article
Removes a tag from a Threat Signals article.
DELETE /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/tags/{tag_id} - Destructive
Delete Threat Signals feed
Unsubscribes the account from a Threat Signals feed and deletes its articles.
DELETE /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id} - Destructive
Update Threat Signals feed
Updates a Threat Signals feed subscription.
PATCH /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id} - Destructive
Set Threat Signals feed skills
Replaces the ordered custom skills assigned to a Threat Signals feed. Requires a paid Threat Signals subscription.
PUT /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id}/skills - Destructive
Delete Threat Signals skill
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.
DELETE /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills/{skill_id} - Destructive
Replace Threat Signals skill tag categories
Replaces the Tag Categories the managed default tagging skill may select tags from. This configures the managed default tagging skill, not Custom Skills.
PUT /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills/{skill_id}/tag-categories
CNIs
- Read
List existing CNI objects
Lists all Cloud Network Interconnects (CNIs) configured for the account, showing connection status and parameters.
GET /accounts/{account_id}/cni/cnis - Read
Get information about a CNI object
Retrieves configuration details for a specific Cloud Network Interconnect (CNI), including connection status and parameters.
GET /accounts/{account_id}/cni/cnis/{cni} - Write
Create a new CNI object
Creates a new Cloud Network Interconnect (CNI) for private network connectivity between Cloudflare and your infrastructure. CNIs enable dedicated, high-performance network links.
POST /accounts/{account_id}/cni/cnis - Destructive
Delete a specified CNI object
Permanently removes a Cloud Network Interconnect (CNI) configuration. The private network connection will be terminated.
DELETE /accounts/{account_id}/cni/cnis/{cni} - Destructive
Modify stored information about a CNI object
Updates the configuration of an existing Cloud Network Interconnect (CNI), including connection parameters and routing settings.
PUT /accounts/{account_id}/cni/cnis/{cni}
Interconnects
- Read
List existing interconnects
Lists all network interconnects configured for the account, including physical and virtual connections.
GET /accounts/{account_id}/cni/interconnects - Read
Get information about an interconnect object
Retrieves configuration and status details for a specific network interconnect.
GET /accounts/{account_id}/cni/interconnects/{icon} - Read
Generate the Letter of Authorization (LOA) for a given interconnect
Downloads the Letter of Authorization (LOA) for a network interconnect, required for physical cross-connect provisioning.
GET /accounts/{account_id}/cni/interconnects/{icon}/loa - Read
Get the default customer name for LOA generation
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.
GET /accounts/{account_id}/cni/interconnects/{icon}/loa/default - Read
Get the current status of an interconnect object
Gets the current operational status of a network interconnect, including link state and traffic metrics.
GET /accounts/{account_id}/cni/interconnects/{icon}/status - Write
Create a new interconnect
Creates a new network interconnect for connecting Cloudflare's network to external networks. Interconnects provide dedicated bandwidth and reduced latency for traffic exchange.
POST /accounts/{account_id}/cni/interconnects - Destructive
Delete an interconnect object
Permanently removes a network interconnect configuration. The physical or virtual connection will be terminated.
DELETE /accounts/{account_id}/cni/interconnects/{icon}
Settings
- Read
Get the current settings for the active account
Retrieves current settings configuration for the specified resource or service.
GET /accounts/{account_id}/cni/settings - Destructive
Update the current settings for the active account
Updates configuration settings for the specified resource or service.
PUT /accounts/{account_id}/cni/settings
Slots
- Read
Retrieve a list of all slots matching the specified parameters
Lists all available infrastructure slots for the account, showing allocation status and capacity.
GET /accounts/{account_id}/cni/slots - Read
Get information about the specified slot
Gets information about a specific infrastructure slot allocation.
GET /accounts/{account_id}/cni/slots/{slot}
Connectivity Services
- Read
List Workers VPC connectivity services
Lists the Workers VPC connectivity services in the account.
GET /accounts/{account_id}/connectivity/directory/services - Read
Get Workers VPC connectivity service
Fetches a single Workers VPC connectivity service by its ID.
GET /accounts/{account_id}/connectivity/directory/services/{service_id} - Write
Create Workers VPC connectivity service
Creates a new Workers VPC connectivity service in the account.
POST /accounts/{account_id}/connectivity/directory/services - Destructive
Delete Workers VPC connectivity service
Removes a single Workers VPC connectivity service by its ID. Any Worker bindings referencing this service will stop working.
DELETE /accounts/{account_id}/connectivity/directory/services/{service_id} - Destructive
Update Workers VPC connectivity service
Updates an existing Workers VPC connectivity service by its ID.
PUT /accounts/{account_id}/connectivity/directory/services/{service_id}
Applications
- Read
List Applications associated with your account
Lists all the applications that are associated with your account.
GET /accounts/{account_id}/containers/applications - Read
Get a single application by id
Returns a single application by id.
GET /accounts/{account_id}/containers/applications/{application_id} - Read
List all application versions
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"`.
GET /accounts/{account_id}/containers/applications/{application_id}/versions - Read
List applications
Returns a list of available applications with use cases and permissions.
GET /accounts/{account_id}/one/applications - Read
Get application details
Returns full application details including auth methods, use cases, and permissions.
GET /accounts/{account_id}/one/applications/{application_id} - Read
Get auth methods
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.
GET /accounts/{account_id}/one/applications/{application_id}/auth-methods - Read
Get application setup flows
Returns all available setup flows for the application, one per auth method.
GET /accounts/{account_id}/one/applications/{application_id}/setup-flows - Read
List applications
List the applications available to an account, both the applications Cloudflare curates and the custom applications the account has defined. Results are paginated. Page with `cursor` so that applications added or removed between requests do not make other results repeat or go missing; `offset` paging can repeat or miss results when the list changes between requests. Use `filter` and `search` to narrow the list, `order_by` to sort it, and `fields` to reduce each result to only the properties you need. Use `lookup` to find complete application names mentioned in a rule sentence, ignoring case. Lookup does not correct misspellings. It ranks matches by relevance and uses the same filters, fields, and pagination as listing. `lookup` cannot be combined with `search`. Invalid UTF-8 or a NUL character (U+0000) in any query parameter name or value returns `400`. The authenticated principal must have access to the account identified by `account_id`.
GET /accounts/{account_id}/resource-library/applications - Read
Look up applications in a rule sentence
Find complete application names mentioned in a rule sentence, ignoring case. Lookup does not correct misspellings. Matches are ranked by relevance. This endpoint takes the rule sentence in the request body, so the text stays out of URLs and request logs. Use it instead of the `lookup` query parameter on the list endpoint when the text may contain sensitive content. `fields`, `limit`, and `filter` work the same way as on the list endpoint and are passed as query parameters. Results are not paged: `offset`, `cursor`, `order_by`, `search`, and `lookup` query parameters return `400`. Unknown request body properties also return `400`. Invalid UTF-8 or a NUL character (U+0000) in any query parameter name or value returns `400`. The authenticated principal must have access to the account identified by `account_id`.
POST /accounts/{account_id}/resource-library/applications/lookup - Read
Get application
Retrieve an application available to the account by its numeric application ID.
GET /accounts/{account_id}/resource-library/applications/{id} - Write
Create a new application
Create a Containers application. Use `scheduling_policy: "default"` for a scheduler-backed application. The Containers scheduler maintains the requested instance count and manages deployment configuration, placement, scaling, versions, and rollouts. Use `scheduling_policy: "durable_object"` for a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Supply `name`, `scheduling_policy`, and `durable_objects`, with optional `configuration` and optional top-level `observability` settings. Deployment configuration, scaling, constraints, versions, and rollouts do not apply.
POST /accounts/{account_id}/containers/applications - Write
Modify an application
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.
PATCH /accounts/{account_id}/containers/applications/{application_id} - Write
Create application
Create a custom application for an account from a name, category, and optional network matchers.
POST /accounts/{account_id}/resource-library/applications - Destructive
Delete a single application by id
Deletes a single application by id.
DELETE /accounts/{account_id}/containers/applications/{application_id} - Destructive
Delete application
Delete a custom application and all of its versions. Deletion is rejected when other resources reference the application.
DELETE /accounts/{account_id}/resource-library/applications/{id} - Destructive
Update application
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.
PATCH /accounts/{account_id}/resource-library/applications/{id}
Container Instances
- Read
List container instances (deprecated) (deprecated)
Deprecated: use `instances-v2` instead. Lists container instances belonging to an application.
GET /accounts/{account_id}/containers/applications/{application_id}/instances - Read
List container instances
Lists container instances belonging to an application.
GET /accounts/{account_id}/containers/applications/{application_id}/instances-v2 - Read
Get a container instance
Returns a container instance belonging to an application.
GET /accounts/{account_id}/containers/applications/{application_id}/instances/{instance_id}
Rollouts
- Destructive
Create a new rollout for an application
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"`.
POST /accounts/{account_id}/containers/applications/{application_id}/rollouts
Container Images
- Write
Prepare a container image
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.
POST /accounts/{account_id}/containers/image-preparations
Image Registries
- Read
Get the list of configured registries in the account
Get the list of configured registries in the account.
GET /accounts/{account_id}/containers/registries - Write
Configure a private external image registry
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. Refer to [Image management](https://developers.cloudflare.com/containers/platform-details/image-management/) for supported registries and instructions for storing registry credentials.
POST /accounts/{account_id}/containers/registries - Write
Generate a JWT to interact with the specified image registry.
Generates credentials for accessing a configured container image registry.
POST /accounts/{account_id}/containers/registries/{domain}/credentials - Destructive
Delete a registry from the account
Delete a registry from the account, this will prevent Containers from pulling images from the registry.
DELETE /accounts/{account_id}/containers/registries/{domain}
Custom CSRs for an Account
- Read
List Custom CSRs
List all custom Certificate Signing Requests (CSRs) for an account.
GET /accounts/{account_id}/custom_csrs - Read
Custom CSR Details
Retrieve details for a specific custom Certificate Signing Request (CSR).
GET /accounts/{account_id}/custom_csrs/{custom_csr_id} - Write
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.
POST /accounts/{account_id}/custom_csrs - Destructive
Delete Custom CSR
Delete a custom Certificate Signing Request (CSR) and its associated private key.
DELETE /accounts/{account_id}/custom_csrs/{custom_csr_id}
Account Level Custom Nameservers
- Read
List Account Custom Nameservers
List an account's custom nameservers.
GET /accounts/{account_id}/custom_ns - Write
Add Account Custom Nameserver
Adds a custom nameserver to the account for use as a vanity nameserver on zones.
POST /accounts/{account_id}/custom_ns - Destructive
Delete Account Custom Nameserver
Removes a custom nameserver from the account.
DELETE /accounts/{account_id}/custom_ns/{custom_ns_id}
Custom pages for an account
- Read
List custom pages
Lists all custom page configurations for an account.
GET /accounts/{account_id}/custom_pages - Read
Get a custom page
Returns the configuration for a custom page type at the account level.
GET /accounts/{account_id}/custom_pages/{identifier} - Write
Create a preview token
Creates a signed JWT for previewing an account-level custom page before it is published.
POST /accounts/{account_id}/custom_pages/preview_tokens - Destructive
Update a custom page
Updates the configuration for a custom page type at the account level.
PUT /accounts/{account_id}/custom_pages/{identifier}
Custom assets for an account
- Read
List custom assets
Lists custom assets for an account.
GET /accounts/{account_id}/custom_pages/assets - Read
Get a custom asset
Returns a custom asset for an account.
GET /accounts/{account_id}/custom_pages/assets/{asset_name} - Write
Create a custom asset
Creates a custom asset for an account.
POST /accounts/{account_id}/custom_pages/assets - Destructive
Delete a custom asset
Deletes a custom asset from an account.
DELETE /accounts/{account_id}/custom_pages/assets/{asset_name} - Destructive
Update a custom asset
Updates a custom asset for an account.
PUT /accounts/{account_id}/custom_pages/assets/{asset_name}
CWS Basic Auth Credentials
- Read
List basic-auth credentials for an account
Returns a paginated list of basic-auth credentials in the account.
GET /accounts/{account_id}/cws/basic-auth-credentials - Read
Get a basic-auth credential by ID
Returns the basic-auth credential with the specified ID.
GET /accounts/{account_id}/cws/basic-auth-credentials/{credential_id} - Read
List secrets for a basic-auth credential
Returns a paginated list of secrets belonging to the credential.
GET /accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets - Read
Get a basic-auth secret by ID
Returns the specified secret's metadata without exposing its password or hash.
GET /accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets/{secret_id} - Write
Create a basic-auth credential
Creates a basic-auth credential with the specified username.
POST /accounts/{account_id}/cws/basic-auth-credentials - Write
Add a secret to a basic-auth credential
Adds a password secret to the credential.
POST /accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets - Destructive
Delete a basic-auth credential
Deletes the credential and its secrets if it is not attached to a deployment.
DELETE /accounts/{account_id}/cws/basic-auth-credentials/{credential_id} - Destructive
Delete a basic-auth secret
Deletes the specified secret from the credential.
DELETE /accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets/{secret_id}
CWS Deployments
- Read
List deployments
Returns a paginated list of deployments in the account.
GET /accounts/{account_id}/cws/deployments - Read
Get a deployment by ID
Returns the deployment with the specified ID.
GET /accounts/{account_id}/cws/deployments/{deployment_id} - Write
Create a new deployment
Creates a deployment with the specified policy sets, domain ACL, and basic-auth credentials.
POST /accounts/{account_id}/cws/deployments - Destructive
Delete a deployment
Deletes the deployment and detaches its associated resources. The resources are not deleted.
DELETE /accounts/{account_id}/cws/deployments/{deployment_id} - Destructive
Update a deployment
Replaces the deployment's mutable configuration and resource attachments.
PUT /accounts/{account_id}/cws/deployments/{deployment_id}
CWS Domain ACLs
- Read
List domain ACLs
Returns a paginated list of domain access control lists in the account.
GET /accounts/{account_id}/cws/domain-acls - Read
Get a domain ACL by ID
Returns the domain access control list with the specified ID.
GET /accounts/{account_id}/cws/domain-acls/{domain_acl_id} - Write
Create a new domain ACL
Creates a domain access control list with its default action and entries.
POST /accounts/{account_id}/cws/domain-acls - Destructive
Delete a domain ACL
Deletes the domain ACL if it is not attached to a deployment.
DELETE /accounts/{account_id}/cws/domain-acls/{domain_acl_id} - Destructive
Update a domain ACL and replace its entries
Replaces the domain access control list's name, default action, and entries.
PUT /accounts/{account_id}/cws/domain-acls/{domain_acl_id}
CWS Policies
- Read
List policies
Returns a paginated list of policies in the account.
GET /accounts/{account_id}/cws/policies - Read
Get a policy by ID
Returns the policy with the specified ID.
GET /accounts/{account_id}/cws/policies/{policy_id} - Write
Create a new policy
Creates a policy from inline Rego source, an entrypoint, and a filter expression.
POST /accounts/{account_id}/cws/policies - Destructive
Delete a policy
Deletes the policy and cascades its policy-set membership rows. The policy sets remain.
DELETE /accounts/{account_id}/cws/policies/{policy_id} - Destructive
Update a policy
Replaces the policy's configuration. Omit tags or use {} to clear them.
PUT /accounts/{account_id}/cws/policies/{policy_id}
CWS Policy Sets
- Read
List policy sets
Returns a paginated list of policy sets in the account.
GET /accounts/{account_id}/cws/policy-sets - Read
Get a policy set by ID
Returns the policy set with the specified ID.
GET /accounts/{account_id}/cws/policy-sets/{policy_set_id} - Write
Create a new policy set
Creates a policy set containing the specified policies and workload targets.
POST /accounts/{account_id}/cws/policy-sets - Destructive
Delete a policy set
Deletes the policy set and cascades its deployment attachment and policy and workload membership rows. The referenced deployments, policies, and workloads remain.
DELETE /accounts/{account_id}/cws/policy-sets/{policy_set_id} - Destructive
Update a policy set
Replaces the policy set's configuration. Omit tags or use {} to clear them.
PUT /accounts/{account_id}/cws/policy-sets/{policy_set_id}
CWS Rego Metadata
- Read
List Rego metadata documents
Returns a paginated list of Rego metadata documents in the account.
GET /accounts/{account_id}/cws/rego-metadata - Read
Get a rego metadata document by ID
Returns the Rego metadata document with the specified ID.
GET /accounts/{account_id}/cws/rego-metadata/{rego_metadata_id} - Write
Create a new rego metadata document
Creates a JSON document that Rego can access through its import path.
POST /accounts/{account_id}/cws/rego-metadata - Destructive
Delete a rego metadata document
Deletes the specified Rego metadata document.
DELETE /accounts/{account_id}/cws/rego-metadata/{rego_metadata_id} - Destructive
Update a rego metadata document
Replaces the metadata document's name, import path, and JSON data.
PUT /accounts/{account_id}/cws/rego-metadata/{rego_metadata_id}
CWS Rego Modules
- Read
List Rego modules
Returns a paginated list of library Rego modules in the account.
GET /accounts/{account_id}/cws/rego-modules - Read
Get a Rego module by ID
Returns the library Rego module with the specified ID.
GET /accounts/{account_id}/cws/rego-modules/{rego_module_id} - Write
Create a new Rego module
Creates a library Rego module and derives its package path from the source.
POST /accounts/{account_id}/cws/rego-modules - Destructive
Delete a Rego module
Deletes the module if no policy or library references its rules.
DELETE /accounts/{account_id}/cws/rego-modules/{rego_module_id} - Destructive
Update a Rego module
Replaces the module and validates policies and libraries that depend on it.
PUT /accounts/{account_id}/cws/rego-modules/{rego_module_id}
CWS Tenant Structures
- Read
List tenant structures for an account
Returns a paginated list of tenant structures in the account.
GET /accounts/{account_id}/cws/tenant-structures - Read
Get a tenant structure by ID
Returns the tenant structure with the specified ID.
GET /accounts/{account_id}/cws/tenant-structures/{structure_id} - Read
List nodes for a tenant structure
Returns a paginated list of nodes in the tenant structure.
GET /accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes - Read
Get a tenant node by ID
Returns the tenant node with the specified ID.
GET /accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id} - Write
Create a tenant structure
Creates an empty tenant hierarchy for the selected cloud application.
POST /accounts/{account_id}/cws/tenant-structures - Write
Add a node to a tenant structure
Adds a validated cloud-native node to the tenant hierarchy.
POST /accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes - Destructive
Delete a tenant structure
Deletes the tenant structure and all nodes in its hierarchy.
DELETE /accounts/{account_id}/cws/tenant-structures/{structure_id} - Destructive
Update a tenant structure
Updates the tenant structure's name and import path; its application remains immutable.
PUT /accounts/{account_id}/cws/tenant-structures/{structure_id} - Destructive
Apply a batch of tenant node mutations
Atomically validates and applies 1 to 500 unordered node operations. Creates may reference new parents but cannot reuse a native_id deleted in the same batch. Maximum body size: 1 MiB.
POST /accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/batch - Destructive
Delete a tenant node
Deletes a childless node from the tenant hierarchy.
DELETE /accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id} - Destructive
Update a tenant node
Updates the node's display name or parent while preserving its immutable identity fields.
PUT /accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id}
CWS Workloads
- Read
List workloads
Returns a paginated list of workloads in the account.
GET /accounts/{account_id}/cws/workloads - Read
Get a workload by ID
Returns the workload with the specified ID.
GET /accounts/{account_id}/cws/workloads/{workload_id} - Write
Create a new workload
Creates a reusable workload selector from a filter expression.
POST /accounts/{account_id}/cws/workloads - Destructive
Delete a workload
Deletes the workload if it is not targeted by a policy set.
DELETE /accounts/{account_id}/cws/workloads/{workload_id} - Destructive
Update a workload
Replaces the workload's configuration. Omit tags or use {} to clear them.
PUT /accounts/{account_id}/cws/workloads/{workload_id}
D1
- Read
List D1 Databases
List D1 databases in your account.
GET /accounts/{account_id}/d1/database - Read
Get D1 Database
Get details for a specific D1 database.
GET /accounts/{account_id}/d1/database/{database_id} - Read
Export D1 Database as SQL
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.
POST /accounts/{account_id}/d1/database/{database_id}/export - Read
Query D1 Database
Execute a SQL query against a D1 database and return results as objects.
POST /accounts/{account_id}/d1/database/{database_id}/query - Read
Get D1 database 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.
GET /accounts/{account_id}/d1/database/{database_id}/time_travel/bookmark - Write
Create D1 Database
Create a new D1 database in your account.
POST /accounts/{account_id}/d1/database - Write
Update D1 Database partially
Partially update a D1 database's configuration.
PATCH /accounts/{account_id}/d1/database/{database_id} - Write
Import SQL into your D1 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.
POST /accounts/{account_id}/d1/database/{database_id}/import - Write
Raw D1 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.
POST /accounts/{account_id}/d1/database/{database_id}/raw - Write
Restore D1 Database to a bookmark or point in time
Restore a D1 database to a previous point in time either via a bookmark or a timestamp.
POST /accounts/{account_id}/d1/database/{database_id}/time_travel/restore - Write
Undelete D1 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. Once a database is undeleted, Time Travel (point-in-time recovery) cannot restore it to a bookmark or timestamp at or before the undeletion. Only states after the undeletion can be restored.
POST /accounts/{account_id}/d1/database/{database_id}/undelete - Destructive
Delete D1 Database
Delete a D1 database.
DELETE /accounts/{account_id}/d1/database/{database_id} - Destructive
Update D1 Database
Update a D1 database's configuration.
PUT /accounts/{account_id}/d1/database/{database_id}
Asset schemas
- Read
List asset schemas
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.
GET /accounts/{account_id}/data-security/posture/asset_schemas - Read
Get asset schema by asset class
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.
GET /accounts/{account_id}/data-security/posture/asset_schemas/{asset_class}
Content
- Read
List DLP content findings
List DLP content findings
GET /accounts/{account_id}/data-security/posture/content
Exports
- Read
List all export jobs
List all export jobs for a given requestor's organization
GET /accounts/{account_id}/data-security/posture/exports - Read
Get a single export job
Retrieves a single export job by its unique identifier
GET /accounts/{account_id}/data-security/posture/exports/{id} - Write
Create a content export
Creates a CSV export for content and accepts optional filters in the payload.
POST /accounts/{account_id}/data-security/posture/content/export - Write
Create new findings export request
Creates a CSV export for findings and accepts optional filters in the payload.
POST /accounts/{account_id}/data-security/posture/findings/export - Write
Create a finding instances export
Creates a CSV export for Finding instances and accepts optional filters in the payload. Identify the finding as `<integration_id>-<finding_type_id>`: join the `integration.id` and `finding.id` of the finding (from the List posture findings response) with a hyphen.
POST /accounts/{account_id}/data-security/posture/findings/{storage_namespace_id}/instances/export - Write
Create a remediation jobs export
Creates a CSV export for remediation jobs and accepts optional filters in the payload.
POST /accounts/{account_id}/data-security/posture/remediations/jobs/export
Finding types
- Read
List all finding types
List all available finding types with pagination support.
GET /accounts/{account_id}/data-security/posture/finding_types - Read
Validate a custom finding type
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. A candidate that fails validation is still a **200** with `result.valid: false` and one entry in `result.errors` per problem — that is the answer this endpoint exists to give. `4xx` is reserved for a request that could not be processed at all, such as a body that will not parse.
POST /accounts/{account_id}/data-security/posture/finding_types/validate - Read
Get finding by ID
Retrieve a specific finding type by its unique identifier.
GET /accounts/{account_id}/data-security/posture/finding_types/{finding_type_id} - Read
List remediation types for a finding type
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.
GET /accounts/{account_id}/data-security/posture/finding_types/{finding_type_id}/remediation_types - Write
Create a custom finding type
Create a new custom finding type with policy definition.
POST /accounts/{account_id}/data-security/posture/finding_types - Destructive
Delete a custom finding type
Delete an existing custom finding type. **Security**: Only custom finding types (not system-managed) can be deleted.
DELETE /accounts/{account_id}/data-security/posture/finding_types/{finding_type_id} - Destructive
Update a custom finding type
Update an existing custom finding type. **Immutable fields**: asset_vendor, asset_class, expression, and category cannot be changed after creation. **Security**: Only custom finding types (not system-managed) can be updated.
PUT /accounts/{account_id}/data-security/posture/finding_types/{finding_type_id}
Findings
- Read
List posture findings
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.
GET /accounts/{account_id}/data-security/posture/findings - Read
Get a posture finding
Gets a security Finding that has been identified as being problematic.
GET /accounts/{account_id}/data-security/posture/findings/{finding_id} - Read
List instances of a finding
Lists all security finding instances for a given security finding.
GET /accounts/{account_id}/data-security/posture/findings/{finding_id}/instances - Read
Get a finding instance using an instance ID
Gets a security Finding instance by id.
GET /accounts/{account_id}/data-security/posture/findings/{finding_id}/instances/{instance_id} - Write
Mark a finding as ignored
Given a list of findings, mark as ignored. Does nothing if Finding is already ignored.
POST /accounts/{account_id}/data-security/posture/findings/ignore - Write
Reset severity for a finding back to the default
If a Finding's severity has been changed, reset it back to default value. Does nothing if no override exists.
POST /accounts/{account_id}/data-security/posture/findings/{finding_id}/reset_finding_severity - Write
Update the severity for a finding
Update the severity of a Finding. This will update the `severity_override` field on the Finding payload with the new severity value.
POST /accounts/{account_id}/data-security/posture/findings/{finding_id}/tune_finding_severity - Destructive
Remove ignore marker from a finding
Ability to un-ignore a Finding if it's previously been ignored. Does nothing if the Finding is not ignored.
POST /accounts/{account_id}/data-security/posture/findings/unignore - Destructive
Archive a finding
Archive one or more finding instances.
POST /accounts/{account_id}/data-security/posture/findings/{finding_id}/instances/archive - Destructive
Remove the archive marking from a finding instance
Remove the archive marking from one or more finding instances.
POST /accounts/{account_id}/data-security/posture/findings/{finding_id}/instances/unarchive
Policies
- Read
List policy configurations
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.
GET /accounts/{account_id}/data-security/posture/policies - Read
Get a policy configuration by ID
Retrieves the details of a specific policy configuration, including its associated remediation and webhook actions.
GET /accounts/{account_id}/data-security/posture/policies/{policy_id} - Read
List policy invocation logs
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. Results are scoped to the requesting account's CASB integrations. The `integration_id` query parameter, when supplied, is intersected against the account's integration allowlist; values outside the allowlist are silently dropped. Pagination is offset-based. The response does not include a total row count; clients should treat a result with fewer than `per_page` entries as the end of the list.
GET /accounts/{account_id}/data-security/posture/policy_logs - Write
Create a new policy configuration
Creates a new policy configuration that defines automated actions to be executed when security findings are detected. A policy can include multiple remediation and/or webhook actions that will be triggered automatically.
POST /accounts/{account_id}/data-security/posture/policies - Destructive
Delete a policy configuration
Deletes a policy configuration.
DELETE /accounts/{account_id}/data-security/posture/policies/{policy_id} - Destructive
Update a policy configuration
Updates an existing policy configuration and replaces its actions.
PUT /accounts/{account_id}/data-security/posture/policies/{policy_id}
Remediations
- Read
List remediation jobs
List all remediation jobs tied to a specific Cloudflare Account. Note that `cursor` and `page` are mutually exclusive.
GET /accounts/{account_id}/data-security/posture/remediations/jobs - Write
Creates remediation jobs
Create one or more remediation jobs tied to a specific Cloudflare Account.
POST /accounts/{account_id}/data-security/posture/remediations/jobs
Webhooks
- Read
List webhook configurations
Retrieves all webhook configurations for the authenticated account. Returns an array of webhook configurations that can be used to send finding notifications.
GET /accounts/{account_id}/data-security/posture/webhooks - Read
Get webhook configuration by ID
Retrieves a specific webhook configuration by its unique identifier.
GET /accounts/{account_id}/data-security/posture/webhooks/{webhook_id} - Read
Fetch all webhooks details
Returns details of all webhooks for an App.
GET /accounts/{account_id}/realtime/kit/{app_id}/webhooks - Read
Fetch all supported webhook events
Returns the list of webhook event names supported by RealtimeKit.
GET /accounts/{account_id}/realtime/kit/{app_id}/webhooks/all - Read
Fetch details of a webhook
Returns webhook details for the given webhook ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id} - Write
Create a new webhook configuration
Creates a new webhook configuration for sending finding notifications to external endpoints.
POST /accounts/{account_id}/data-security/posture/webhooks - Write
Test a webhook configuration before creating it
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. The test payload includes: - event_type: "webhook.test" - timestamp: Current UTC timestamp - message: Test message indicating this is from Cloudflare CASB - data: Object with test: true
POST /accounts/{account_id}/data-security/posture/webhooks/evaluate - Write
Create webhook jobs
Creates webhook jobs to send a finding instance to one or more configured webhooks.
POST /accounts/{account_id}/data-security/posture/webhooks/jobs - Write
Test an existing webhook configuration
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. The test payload includes: - event_type: "webhook.test" - timestamp: Current UTC timestamp - message: Test message indicating this is from Cloudflare CASB - data: Object with test: true
POST /accounts/{account_id}/data-security/posture/webhooks/{webhook_id}/evaluate - Write
Add a webhook
Adds a new webhook to an App.
POST /accounts/{account_id}/realtime/kit/{app_id}/webhooks - Write
Edit a webhook
Edits the webhook details for the given webhook ID.
PATCH /accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id} - Destructive
Delete a webhook configuration
Soft deletes a webhook configuration by its unique identifier. The webhook will be marked as deleted and will no longer be available for use.
DELETE /accounts/{account_id}/data-security/posture/webhooks/{webhook_id} - Destructive
Update an existing webhook configuration
Updates an existing webhook configuration with new settings.
PUT /accounts/{account_id}/data-security/posture/webhooks/{webhook_id} - Destructive
Delete a webhook
Removes a webhook for the given webhook ID.
DELETE /accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id} - Destructive
Replace a webhook
Replace all details for the given webhook ID.
PUT /accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}
Devices
- Read
List devices (deprecated) (deprecated)
List WARP devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account. **Deprecated**: please use one of the following endpoints instead: - GET /accounts/{account_id}/devices/physical-devices - GET /accounts/{account_id}/devices/registrations
GET /accounts/{account_id}/devices - Read
List device settings profiles
Fetches a list of the device settings profiles for an account.
GET /accounts/{account_id}/devices/policies - Read
Get the default device settings profile
Fetches the default device settings profile for an account.
GET /accounts/{account_id}/devices/policy - Read
Get the Split Tunnel exclude list
Fetches the list of routes excluded from the WARP client's tunnel.
GET /accounts/{account_id}/devices/policy/exclude - Read
Get your Local Domain Fallback list
Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.
GET /accounts/{account_id}/devices/policy/fallback_domains - Read
Get the Split Tunnel include list
Fetches the list of routes included in the WARP client's tunnel.
GET /accounts/{account_id}/devices/policy/include - Read
Get device settings profile by ID
Fetches a device settings profile by ID.
GET /accounts/{account_id}/devices/policy/{policy_id} - Read
Get the Split Tunnel exclude list for a device settings profile
Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
GET /accounts/{account_id}/devices/policy/{policy_id}/exclude - Read
Get the Local Domain Fallback list for a device settings profile
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.
GET /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains - Read
Get the Split Tunnel include list for a device settings profile
Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.
GET /accounts/{account_id}/devices/policy/{policy_id}/include - Read
Get device (deprecated) (deprecated)
Fetches a single WARP device. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account. **Deprecated**: please use one of the following endpoints instead: - GET /accounts/{account_id}/devices/physical-devices/{device_id} - GET /accounts/{account_id}/devices/registrations/{registration_id}
GET /accounts/{account_id}/devices/{device_id} - Read
Get override codes (deprecated) (deprecated)
Fetches a one-time use admin override code for a device. This relies on the **Admin Override** setting being enabled in your device configuration. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account. **Deprecated:** please use GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codes instead.
GET /accounts/{account_id}/devices/{device_id}/override_codes - Read
Get device certificate provisioning status
Fetches device certificate provisioning.
GET /zones/{zone_id}/devices/policy/certificates - Write
Update the default device settings profile
Updates the default device settings profile for an account.
PATCH /accounts/{account_id}/devices/policy - Write
Create a device settings profile
Creates a device settings profile to be applied to certain devices matching the criteria.
POST /accounts/{account_id}/devices/policy - Write
Update a device settings profile
Updates a configured device settings profile.
PATCH /accounts/{account_id}/devices/policy/{policy_id} - Write
Unrevoke devices (deprecated) (deprecated)
Unrevokes a list of devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled. **Deprecated**: please use POST /accounts/{account_id}/devices/registrations/unrevoke instead.
POST /accounts/{account_id}/devices/unrevoke - Write
Update device certificate provisioning status
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.
PATCH /zones/{zone_id}/devices/policy/certificates - Destructive
Reset Split Tunnel exclude list
Resets the Split Tunnel exclude list to the default value.
DELETE /accounts/{account_id}/devices/policy/exclude - Destructive
Set the Split Tunnel exclude list
Sets the list of routes excluded from the WARP client's tunnel.
PUT /accounts/{account_id}/devices/policy/exclude - Destructive
Reset Local Domain Fallback
Restores the default Local Domain Fallback list for the default device profile.
DELETE /accounts/{account_id}/devices/policy/fallback_domains - Destructive
Set your Local Domain Fallback list
Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.
PUT /accounts/{account_id}/devices/policy/fallback_domains - Destructive
Set the Split Tunnel include list
Sets the list of routes included in the WARP client's tunnel.
PUT /accounts/{account_id}/devices/policy/include - Destructive
Delete a device settings profile
Deletes a device settings profile and fetches a list of the remaining profiles for an account.
DELETE /accounts/{account_id}/devices/policy/{policy_id} - Destructive
Reset Split Tunnel exclude list
Resets the Split Tunnel exclude list to the default value for the selected device profile.
DELETE /accounts/{account_id}/devices/policy/{policy_id}/exclude - Destructive
Set the Split Tunnel exclude list for a device settings profile
Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
PUT /accounts/{account_id}/devices/policy/{policy_id}/exclude - Destructive
Reset Local Domain Fallback
Restores the default Local Domain Fallback list for a specific device profile.
DELETE /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains - Destructive
Set the Local Domain Fallback list for a device settings profile
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.
PUT /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains - Destructive
Set the Split Tunnel include list for a device settings profile
Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.
PUT /accounts/{account_id}/devices/policy/{policy_id}/include - Destructive
Revoke devices (deprecated) (deprecated)
Revokes a list of devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled. **Deprecated**: please use POST /accounts/{account_id}/devices/registrations/revoke instead.
POST /accounts/{account_id}/devices/revoke
Client Versions
- Read
List client versions
Lists available WARP client versions for a specific target environment and release track. This endpoint is in Beta.
GET /accounts/{account_id}/devices/client-versions - Read
List available target environments
Retrieves a list of all available target environments with their display names. This endpoint is in Beta.
GET /accounts/{account_id}/devices/client-versions/target-environments
Deployment Groups
- Read
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.
GET /accounts/{account_id}/devices/deployment-groups - Read
Get deployment group
Fetches a single deployment group by its ID. This endpoint is in Beta.
GET /accounts/{account_id}/devices/deployment-groups/{group_id} - Write
Create deployment group
Creates a new deployment group. Policy IDs must be unique across all deployment groups. This endpoint is in Beta.
POST /accounts/{account_id}/devices/deployment-groups - Destructive
Delete deployment group
Deletes a deployment group. Associated policies no longer apply and devices stop receiving version targets. This endpoint is in Beta.
DELETE /accounts/{account_id}/devices/deployment-groups/{group_id} - Destructive
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.
PATCH /accounts/{account_id}/devices/deployment-groups/{group_id}
IP Profiles
- Read
List IP profiles
Lists WARP Device IP profiles.
GET /accounts/{account_id}/devices/ip-profiles - Read
Get IP profile
Fetches a single WARP Device IP profile.
GET /accounts/{account_id}/devices/ip-profiles/{profile_id} - Write
Create IP profile
Creates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.
POST /accounts/{account_id}/devices/ip-profiles - Write
Update IP profile
Updates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.
PATCH /accounts/{account_id}/devices/ip-profiles/{profile_id} - Destructive
Delete IP profile
Delete a WARP Device IP profile.
DELETE /accounts/{account_id}/devices/ip-profiles/{profile_id}
Device Managed Networks
- Read
List your device managed networks
Fetches a list of managed networks for an account.
GET /accounts/{account_id}/devices/networks - Read
Get device managed network details
Fetches details for a single managed network.
GET /accounts/{account_id}/devices/networks/{network_id} - Write
Create a device managed network
Creates a new device managed network.
POST /accounts/{account_id}/devices/networks - Destructive
Delete a device managed network
Deletes a device managed network and fetches a list of the remaining device managed networks for an account.
DELETE /accounts/{account_id}/devices/networks/{network_id} - Destructive
Update a device managed network
Updates a configured device managed network.
PUT /accounts/{account_id}/devices/networks/{network_id}
Override Codes
- Write
Generate an uninstall protection override code
Generates an account-wide or device-specific uninstall protection override code.
POST /accounts/{account_id}/devices/override_codes
Physical Devices
- Read
List devices
Lists WARP devices.
GET /accounts/{account_id}/devices/physical-devices - Read
Get device
Fetches a single WARP device.
GET /accounts/{account_id}/devices/physical-devices/{device_id} - Destructive
Delete device
Deletes a WARP device.
DELETE /accounts/{account_id}/devices/physical-devices/{device_id} - Destructive
Update device
Updates properties of a WARP device.
PATCH /accounts/{account_id}/devices/physical-devices/{device_id} - Destructive
Revoke device registrations (deprecated)
Revokes all WARP registrations associated with the specified device. Prefer "delete" operation instead, "revoke" does not release virtual IPs.
POST /accounts/{account_id}/devices/physical-devices/{device_id}/revoke - Destructive
Delete registrations
Deletes a list of WARP registrations.
DELETE /accounts/{account_id}/devices/registrations
Device posture rules
- Read
List posture rules
Fetches device posture rules for a Zero Trust account.
GET /accounts/{account_id}/devices/posture - Read
Get posture rule
Fetches a single device posture rule.
GET /accounts/{account_id}/devices/posture/{rule_id} - Write
Create posture rule
Creates a new device posture rule.
POST /accounts/{account_id}/devices/posture - Destructive
Delete posture rule
Deletes a device posture rule.
DELETE /accounts/{account_id}/devices/posture/{rule_id} - Destructive
Update posture rule
Updates a device posture rule.
PUT /accounts/{account_id}/devices/posture/{rule_id}
Device Posture Integrations
- Read
List posture integrations
Fetches the list of device posture integrations for an account.
GET /accounts/{account_id}/devices/posture/integration - Read
Get posture integration
Fetches details for a single device posture integration.
GET /accounts/{account_id}/devices/posture/integration/{integration_id} - Write
Create posture integration
Create a new device posture integration.
POST /accounts/{account_id}/devices/posture/integration - Write
Update posture integration
Updates a configured device posture integration.
PATCH /accounts/{account_id}/devices/posture/integration/{integration_id} - Destructive
Delete posture integration
Delete a configured device posture integration.
DELETE /accounts/{account_id}/devices/posture/integration/{integration_id}
Registrations
- Read
List registrations
Lists WARP registrations.
GET /accounts/{account_id}/devices/registrations - Read
Get registration
Fetches a single WARP registration.
GET /accounts/{account_id}/devices/registrations/{registration_id} - Write
Unrevoke registrations (deprecated)
Unrevokes a list of WARP registrations.
POST /accounts/{account_id}/devices/registrations/unrevoke - Destructive
Revoke registrations (deprecated)
Revokes a list of WARP registrations. Prefer "delete" operation instead, "revoke" does not release virtual IPs.
POST /accounts/{account_id}/devices/registrations/revoke - Destructive
Delete registration
Deletes a WARP registration.
DELETE /accounts/{account_id}/devices/registrations/{registration_id}
Warp teams device api other
- Read
Get 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.
GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codes
Devices Resilience
- Read
Get Global Disconnect
Fetch the Global WARP disconnect state.
GET /accounts/{account_id}/devices/resilience/disconnect - Write
Set Global Disconnect
Sets the Global WARP disconnect state.
POST /accounts/{account_id}/devices/resilience/disconnect
Zero Trust accounts
- Read
Get device settings
Describes the current device settings for a Zero Trust account.
GET /accounts/{account_id}/devices/settings - Read
Get Zero Trust account information
Retrieve information about the current Zero Trust account.
GET /accounts/{account_id}/gateway - Read
Get Zero Trust account configuration
Retrieve the current Zero Trust account configuration.
GET /accounts/{account_id}/gateway/configuration - Read
Get Zero Trust certificate configuration (deprecated)
Retrieve the current Zero Trust certificate configuration.
GET /accounts/{account_id}/gateway/configuration/custom_certificate - Read
Get gateway egress CIDRs pairs assigned to this account
Retrieve the list of egress CIDRs allocated to this Zero Trust account.
GET /accounts/{account_id}/gateway/egress_cidr_pairs - Read
Get logging settings for the Zero Trust account
Retrieve the current logging settings for the Zero Trust account.
GET /accounts/{account_id}/gateway/logging - Write
Update device settings
Updates the device settings for a Zero Trust account.
PATCH /accounts/{account_id}/devices/settings - Write
Create Zero Trust account
Create a Zero Trust account for an existing Cloudflare account.
POST /accounts/{account_id}/gateway - Write
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.
PATCH /accounts/{account_id}/gateway/configuration - Destructive
Reset device settings
Resets the current device settings for a Zero Trust account.
DELETE /accounts/{account_id}/devices/settings - Destructive
Update device settings (deprecated) (deprecated)
Deprecated: use "PATCH /accounts/{account_id}/devices/settings" instead
PUT /accounts/{account_id}/devices/settings - Destructive
Update Zero Trust account configuration
Update the current Zero Trust account configuration.
PUT /accounts/{account_id}/gateway/configuration - Destructive
Update Zero Trust account logging settings
Update logging settings for the current Zero Trust account.
PUT /accounts/{account_id}/gateway/logging
DEX Synthetic Application Monitoring
- Read
List Cloudflare 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.
GET /accounts/{account_id}/dex/colos - Read
List Device DEX tests
Fetch all DEX tests.
GET /accounts/{account_id}/dex/devices/dex_tests - Read
Get Device DEX test
Fetch a single DEX test.
GET /accounts/{account_id}/dex/devices/dex_tests/{dex_test_id} - Read
Get the latest status of a device.
Get the latest status of a device given device_id from the device_state table.
GET /accounts/{account_id}/dex/devices/{device_id}/fleet-status/live - Read
Get the status over time for a device
Get time-bucketed status metrics for a specific device.
GET /accounts/{account_id}/dex/devices/{device_id}/fleet-status/over-time - Read
List device ISPs
List ISP information observed for a specific device during traceroute tests.
GET /accounts/{account_id}/dex/devices/{device_id}/isps - Read
List details of devices using WARP.
List details of devices using WARP.
GET /accounts/{account_id}/dex/fleet-status/devices - Read
Get live aggregate device details by dimension
Get details for live (up to 60 minutes) devices using WARP.
GET /accounts/{account_id}/dex/fleet-status/live - Read
Get over time aggregate details for devices by dimension
Get aggregate details for devices using WARP, up to 7 days.
GET /accounts/{account_id}/dex/fleet-status/over-time - Read
Get details and aggregate metrics for an http test
Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days.
GET /accounts/{account_id}/dex/http-tests/{test_id} - Read
Get percentiles for an http test
Get percentiles for an http test for a given time period between 1 hour and 7 days.
GET /accounts/{account_id}/dex/http-tests/{test_id}/percentiles - Read
List DEX test analytics
List DEX tests with overview metrics.
GET /accounts/{account_id}/dex/tests/overview - Read
Get count of devices targeted
Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days.
GET /accounts/{account_id}/dex/tests/unique-devices - Read
Get details for a specific traceroute test run
Get a breakdown of hops and performance metrics for a specific traceroute test run
GET /accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path - Read
Get details and aggregate metrics for a traceroute test
Get test details and aggregate performance metrics for a traceroute test for a given time period between 1 hour and 7 days.
GET /accounts/{account_id}/dex/traceroute-tests/{test_id} - Read
Get network path breakdown for a traceroute test
Get a breakdown of metrics by hop for individual traceroute test runs.
GET /accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path - Read
Get percentiles for a traceroute test
Get percentiles for a traceroute test for a given time period between 1 hour and 7 days.
GET /accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles - Write
Create Device DEX test
Create a DEX test.
POST /accounts/{account_id}/dex/devices/dex_tests - Destructive
Delete Device DEX test
Delete a Device DEX test. Returns the remaining device dex tests for the account.
DELETE /accounts/{account_id}/dex/devices/dex_tests/{dex_test_id} - Destructive
Update Device DEX test
Update a DEX test.
PUT /accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}
DEX Remote Commands
- Read
List account commands
Retrieves a paginated list of commands issued to devices under the specified account, optionally filtered by time range, device, or other parameters
GET /accounts/{account_id}/dex/commands - Read
List devices eligible for remote captures
List devices with WARP client support for remote captures which have been connected in the last 1 hour.
GET /accounts/{account_id}/dex/commands/devices - Read
Returns account commands usage, quota, and reset time
Retrieves the current quota usage and limits for device commands within a specific account, including the time when the quota will reset
GET /accounts/{account_id}/dex/commands/quota - Read
Download command output file
Downloads artifacts for an executed command. Bulk downloads are not supported
GET /accounts/{account_id}/dex/commands/{command_id}/downloads/{filename} - Write
Create account commands
Initiate commands for up to 10 devices per account.
POST /accounts/{account_id}/dex/commands
DEX Rules
- Read
List DEX Rules
List DEX Rules.
GET /accounts/{account_id}/dex/rules - Read
Get DEX Rule
Get details for a DEX Rule.
GET /accounts/{account_id}/dex/rules/{rule_id} - Write
Create a DEX Rule
Create a DEX Rule.
POST /accounts/{account_id}/dex/rules - Write
Update a DEX Rule
Update a DEX Rule.
PATCH /accounts/{account_id}/dex/rules/{rule_id} - Destructive
Delete a DEX Rule
Delete a DEX Rule.
DELETE /accounts/{account_id}/dex/rules/{rule_id}
WARP Change Events
- Read
List WARP change events.
List WARP configuration and enablement toggle change events by device.
GET /accounts/{account_id}/dex/warp-change-events
Endpoint Health Checks
- Read
List Endpoint Health Checks
List Endpoint Health Checks.
GET /accounts/{account_id}/diagnostics/endpoint-healthchecks - Read
Get Endpoint Health Check
Get a single Endpoint Health Check.
GET /accounts/{account_id}/diagnostics/endpoint-healthchecks/{id} - Write
Endpoint Health Check
Create Endpoint Health Check.
POST /accounts/{account_id}/diagnostics/endpoint-healthchecks - Destructive
Delete Endpoint Health Check
Delete Endpoint Health Check.
DELETE /accounts/{account_id}/diagnostics/endpoint-healthchecks/{id} - Destructive
Update Endpoint Health Check
Update an Endpoint Health Check.
PUT /accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}
Diagnostics
- Write
Traceroute
Run traceroutes from Cloudflare colos.
POST /accounts/{account_id}/diagnostics/traceroute
DLP Custom Prompt Topics
- Read
List custom prompt topics
Lists all DLP custom prompt topic entries in an account.
GET /accounts/{account_id}/dlp/custom_prompt_topics - Read
Get custom prompt topic
Fetches a DLP custom prompt topic entry by ID.
GET /accounts/{account_id}/dlp/custom_prompt_topics/{entry_id} - Write
Create custom prompt topic
Creates a DLP custom prompt topic entry.
POST /accounts/{account_id}/dlp/custom_prompt_topics - Destructive
Delete custom prompt topic
Deletes a DLP custom prompt topic entry.
DELETE /accounts/{account_id}/dlp/custom_prompt_topics/{entry_id} - Destructive
Update custom prompt topic
Updates a DLP custom prompt topic entry.
PUT /accounts/{account_id}/dlp/custom_prompt_topics/{entry_id}
DLP Data Classes
- Read
Retrieve all data classes in an account
Lists data classes configured for the account.
GET /accounts/{account_id}/dlp/data_classes - Read
Retrieve a specific data class
Gets the configuration for a data class.
GET /accounts/{account_id}/dlp/data_classes/{data_class_id} - Write
Creates a new data class
Creates a data class for use in DLP profiles.
POST /accounts/{account_id}/dlp/data_classes - Destructive
Delete a single data class
Deletes a data class from the account.
DELETE /accounts/{account_id}/dlp/data_classes/{data_class_id} - Destructive
Update the attributes of a single data class
Updates the configuration for a data class.
PUT /accounts/{account_id}/dlp/data_classes/{data_class_id}
DLP Data Tag Categories
- Read
Retrieve all data tag categories in an account
Lists data tag categories configured for the account.
GET /accounts/{account_id}/dlp/data_tag_categories - Read
Retrieve a specific data tag category.
Gets a data tag category and its tags.
GET /accounts/{account_id}/dlp/data_tag_categories/{category_id} - Write
Creates a new data tag category.
Creates a data tag category, optionally from a template.
POST /accounts/{account_id}/dlp/data_tag_categories - Destructive
Delete a single data tag category.
Deletes a data tag category and its tags.
DELETE /accounts/{account_id}/dlp/data_tag_categories/{category_id} - Destructive
Update the attributes of a single data tag category.
Updates a data tag category and its tags.
PUT /accounts/{account_id}/dlp/data_tag_categories/{category_id}
DLP Data Tags
- Read
Retrieve all data tags in a data tag category
Lists data tags in a category.
GET /accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags - Read
Retrieve a specific data tag.
Gets a data tag from a category.
GET /accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags/{tag_id} - Write
Creates a new data tag.
Creates a data tag in a category.
POST /accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags - Destructive
Delete a single data tag.
Deletes a data tag from a category.
DELETE /accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags/{tag_id} - Destructive
Update the attributes of a single data tag.
Updates a data tag in a category.
PUT /accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags/{tag_id}
DLP Data Tag Category Templates
- Read
Retrieve all data tag category templates in an account
Lists available data tag category templates.
GET /accounts/{account_id}/dlp/data_tag_category_templates - Read
Retrieve a specific data tag category template.
Gets an available data tag category template.
GET /accounts/{account_id}/dlp/data_tag_category_templates/{template_id}
DLP Datasets
- Read
Fetch all datasets
Lists all DLP datasets configured for the account, including custom word lists and EDM datasets.
GET /accounts/{account_id}/dlp/datasets - Read
Fetch a specific dataset
Gets a dataset and its latest upload status.
GET /accounts/{account_id}/dlp/datasets/{dataset_id} - Write
Create a new dataset
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.
POST /accounts/{account_id}/dlp/datasets - Write
Prepare to upload a new version of a dataset
Creates a new version of a DLP dataset, allowing you to stage changes before activation. Used for single-column EDM and custom word lists.
POST /accounts/{account_id}/dlp/datasets/{dataset_id}/upload - Write
Upload a new version of a dataset
This is used for single-column EDMv1 and Custom Word Lists. The EDM format can only be created in the Cloudflare dashboard. For other clients, this operation can only be used for non-secret Custom Word Lists. The body must be a UTF-8 encoded, newline (NL or CRNL) separated list of words to be matched.
POST /accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version} - Write
Sets the column information for a multi-column upload
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.
POST /accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version} - Write
Upload a new version of a multi-column dataset
This is used for multi-column EDMv2 datasets. The EDMv2 format can only be created in the Cloudflare dashboard.
POST /accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id} - Destructive
Delete a dataset
This deletes all versions of the dataset.
DELETE /accounts/{account_id}/dlp/datasets/{dataset_id} - Destructive
Update details about a dataset
Updates the configuration of an existing DLP dataset, such as its name, description, or detection settings.
PUT /accounts/{account_id}/dlp/datasets/{dataset_id}
DLP Document Fingerprints
- Read
Retrieve data about all document fingerprints.
Lists all document fingerprints configured for DLP scanning in the account.
GET /accounts/{account_id}/dlp/document_fingerprints - Read
Retrieve data about a specific document fingerprint.
Gets a document fingerprint and its latest upload status.
GET /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id} - Write
Creates a new document fingerprint.
Creates a new document fingerprint for DLP scanning. Document fingerprints detect documents that are structurally similar to the uploaded sample.
POST /accounts/{account_id}/dlp/document_fingerprints - Write
Update the attributes of a single document fingerprint.
Updates metadata for an existing document fingerprint, such as its name or description.
POST /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id} - Destructive
Delete a single document fingerprint.
Removes a document fingerprint from DLP configuration. Documents matching this fingerprint will no longer be detected.
DELETE /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id} - Destructive
Uploads a new version for a document fingerprint.
Uploads a new document to create or update a fingerprint. The document structure is analyzed to enable detection of similar documents.
PUT /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id}
DLP Email
- Read
Get mapping
Retrieves the email provider mapping configuration for DLP email scanning.
GET /accounts/{account_id}/dlp/email/account_mapping - Read
List all email scanner rules
Lists all email scanner rules for an account.
GET /accounts/{account_id}/dlp/email/rules - Read
Get an email scanner rule
Gets detailed configuration for a specific DLP email scanning rule, including detection patterns and actions.
GET /accounts/{account_id}/dlp/email/rules/{rule_id} - Write
Create mapping
Creates a mapping between a Cloudflare account and an email provider for DLP email scanning integration.
POST /accounts/{account_id}/dlp/email/account_mapping - Write
Update email scanner rule priorities
Reorders DLP email scanning rules by updating their priority values. Higher priority rules are evaluated first.
PATCH /accounts/{account_id}/dlp/email/rules - Write
Create email scanner rule
Creates a new DLP email scanning rule that defines what content patterns to detect in email messages and what actions to take.
POST /accounts/{account_id}/dlp/email/rules - Destructive
Delete email scanner rule
Removes a DLP email scanning rule. The rule will no longer be applied to email messages.
DELETE /accounts/{account_id}/dlp/email/rules/{rule_id} - Destructive
Update email scanner rule
Updates a DLP email scanning rule.
PUT /accounts/{account_id}/dlp/email/rules/{rule_id}
DLP Entries
- Read
List all entries
Lists all DLP entries in an account.
GET /accounts/{account_id}/dlp/entries - Read
Get DLP Entry
Fetches a DLP entry by ID.
GET /accounts/{account_id}/dlp/entries/{entry_id} - Write
Create custom entry
Creates a DLP custom entry.
POST /accounts/{account_id}/dlp/entries - Destructive
Update custom entry
Updates a DLP custom entry.
PUT /accounts/{account_id}/dlp/entries/custom/{entry_id} - Destructive
Update predefined entry
Updates a DLP entry.
PUT /accounts/{account_id}/dlp/entries/predefined/{entry_id} - Destructive
Delete custom entry
Deletes a DLP custom entry.
DELETE /accounts/{account_id}/dlp/entries/{entry_id} - Destructive
Update entry
Updates a DLP entry.
PUT /accounts/{account_id}/dlp/entries/{entry_id}
DLP Integration Entries
- Write
Create integration entry
Integration entries can't be created, this will update an existing integration entry. This is needed for our generated terraform API.
POST /accounts/{account_id}/dlp/entries/integration - Destructive
Delete integration entry
This is a no-op as integration entires can't be deleted but is needed for our generated terraform API.
DELETE /accounts/{account_id}/dlp/entries/integration/{entry_id} - Destructive
Update integration entry
Updates a DLP entry.
PUT /accounts/{account_id}/dlp/entries/integration/{entry_id}
DLP Predefined Entries
- Write
Create predefined entry
Predefined entries can't be created, this will update an existing predefined entry. This is needed for our generated terraform API.
POST /accounts/{account_id}/dlp/entries/predefined - Destructive
Delete predefined entry
This is a no-op as predefined entires can't be deleted but is needed for our generated terraform API.
DELETE /accounts/{account_id}/dlp/entries/predefined/{entry_id}
DLP Settings
- Read
Fetch limits associated with DLP for account
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.
GET /accounts/{account_id}/dlp/limits - Read
Validate a DLP regex pattern
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}`.
POST /accounts/{account_id}/dlp/patterns/validate - Read
Get payload log settings (deprecated)
Gets the current payload logging configuration for DLP, showing whether matched content is being logged.
GET /accounts/{account_id}/dlp/payload_log - Read
Get DLP account-level settings.
Gets the account-level DLP settings.
GET /accounts/{account_id}/dlp/settings - Write
Partially update DLP account-level settings.
Missing fields keep their existing values.
PATCH /accounts/{account_id}/dlp/settings - Destructive
Set payload log settings (deprecated)
Enables or disables payload logging for DLP matches. When enabled, matched content is stored for review.
PUT /accounts/{account_id}/dlp/payload_log - Destructive
Delete (reset) DLP account-level settings to initial values.
Deletes account-level DLP settings and returns the initial values.
DELETE /accounts/{account_id}/dlp/settings - Destructive
Update DLP account-level settings (full replacement).
Missing fields are reset to initial (unconfigured) values.
PUT /accounts/{account_id}/dlp/settings
DLP Profiles
- Read
List all profiles
Lists all DLP profiles in an account.
GET /accounts/{account_id}/dlp/profiles - Read
List all custom profiles
Lists all DLP custom profiles in an account.
GET /accounts/{account_id}/dlp/profiles/custom - Read
Get custom profile
Fetches a custom DLP profile by id.
GET /accounts/{account_id}/dlp/profiles/custom/{profile_id} - Read
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.
GET /accounts/{account_id}/dlp/profiles/integration/{profile_id}/references - Read
Get predefined profile
Fetches a predefined DLP profile by id.
GET /accounts/{account_id}/dlp/profiles/predefined/{profile_id} - Read
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.
GET /accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config - Read
Get DLP Profile
Fetches a DLP profile by ID.
GET /accounts/{account_id}/dlp/profiles/{profile_id} - Write
Create custom profile
Creates a DLP custom profile.
POST /accounts/{account_id}/dlp/profiles/custom - Write
Create predefined profile
Creates a DLP predefined profile. Only supports enabling/disabling entries.
POST /accounts/{account_id}/dlp/profiles/predefined - Write
Create predefined profile
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.
POST /accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config - Destructive
Delete custom profile
Deletes a DLP custom profile.
DELETE /accounts/{account_id}/dlp/profiles/custom/{profile_id} - Destructive
Update custom profile
Updates a DLP custom profile.
PUT /accounts/{account_id}/dlp/profiles/custom/{profile_id} - Destructive
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.
DELETE /accounts/{account_id}/dlp/profiles/integration/{profile_id} - Destructive
Delete predefined profile
This is a no-op as predefined profiles can't be deleted but is needed for our generated terraform API.
DELETE /accounts/{account_id}/dlp/profiles/predefined/{profile_id} - Destructive
Update predefined profile
Updates a DLP predefined profile. Only supports enabling/disabling entries.
PUT /accounts/{account_id}/dlp/profiles/predefined/{profile_id} - Destructive
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.
PUT /accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config
DLP Sensitivity Groups
- Read
Retrieve all sensitivity groups in an account
Lists sensitivity groups configured for the account.
GET /accounts/{account_id}/dlp/sensitivity_groups - Read
Retrieve a specific sensitivity group.
Gets a sensitivity group and its levels.
GET /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id} - Read
Retrieve the ordered list of level IDs for a sensitivity group.
Gets the current order of sensitivity levels in a group.
GET /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/level_order - Write
Creates a new sensitivity group.
Creates a sensitivity group, optionally from a template.
POST /accounts/{account_id}/dlp/sensitivity_groups - Destructive
Delete a single sensitivity group.
Deletes a sensitivity group and its levels.
DELETE /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id} - Destructive
Update the attributes of a single sensitivity group.
Updates a sensitivity group and its levels.
PUT /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id} - Destructive
Set the ordering of levels within a sensitivity group.
Updates the order of sensitivity levels in a group.
PUT /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/level_order
DLP Sensitivity Group Templates
- Read
Retrieve all sensitivity group templates in an account
Lists available sensitivity group templates.
GET /accounts/{account_id}/dlp/sensitivity_groups/templates - Read
Retrieve a specific sensitivity group template.
Gets an available sensitivity group template.
GET /accounts/{account_id}/dlp/sensitivity_groups/templates/{template_id}
DLP Sensitivity Levels
- Read
Retrieve all sensitivity levels in a sensitivity group
Lists sensitivity levels in a sensitivity group.
GET /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels - Read
Retrieve a specific sensitivity level.
Gets a sensitivity level from a group.
GET /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels/{sensitivity_level_id} - Write
Creates a new sensitivity level.
Creates a sensitivity level in a group.
POST /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels - Destructive
Delete a single sensitivity level.
Deletes a sensitivity level from a group.
DELETE /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels/{sensitivity_level_id} - Destructive
Update the attributes of a single sensitivity level.
Updates a sensitivity level in a group.
PUT /accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels/{sensitivity_level_id}
DLP Validators
- Read
List validators
Lists the validators configured for the account, of every kind.
GET /accounts/{account_id}/dlp/validators - Read
List proximity word validators
Lists the `proximity_words` validators configured for the account.
GET /accounts/{account_id}/dlp/validators/proximity_words - Read
Get a proximity word validator
Fetches a `proximity_words` validator by ID.
GET /accounts/{account_id}/dlp/validators/proximity_words/{validator_id} - Read
List worker validators
Lists the `worker` validators configured for the account.
GET /accounts/{account_id}/dlp/validators/worker - Read
Get a worker validator
Fetches a `worker` validator by ID.
GET /accounts/{account_id}/dlp/validators/worker/{validator_id} - Read
Get a 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.
GET /accounts/{account_id}/dlp/validators/worker/{validator_id}/status - Read
Get a validator
Fetches a validator of any kind by ID.
GET /accounts/{account_id}/dlp/validators/{validator_id} - Write
Create a proximity word 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.
POST /accounts/{account_id}/dlp/validators/proximity_words - Write
Create a worker validator
Registers a customer Worker as a validator. An account may own at most 100 validators across all kinds.
POST /accounts/{account_id}/dlp/validators/worker - Destructive
Delete a proximity word validator
Deletes a `proximity_words` validator. Fails with `409` while any detection entry is still attached to it; detach it from those entries first.
DELETE /accounts/{account_id}/dlp/validators/proximity_words/{validator_id} - Destructive
Update a proximity word 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.
PUT /accounts/{account_id}/dlp/validators/proximity_words/{validator_id} - Destructive
Delete a worker validator
Deletes a `worker` validator. Fails with `409` while any detection entry is still attached to it; detach it from those entries first.
DELETE /accounts/{account_id}/dlp/validators/worker/{validator_id} - Destructive
Update a 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.
PUT /accounts/{account_id}/dlp/validators/worker/{validator_id}
Prefix Bindings
- Read
List DLS prefix bindings for an account
List the BYOIP prefix bindings configured for an account.
GET /accounts/{account_id}/dls/regional_services/prefix_bindings - Read
Get a DLS prefix binding
Retrieve a single BYOIP prefix binding by ID.
GET /accounts/{account_id}/dls/regional_services/prefix_bindings/{binding_id} - Write
Create a DLS prefix binding
Bind a CIDR from a BYOIP prefix to a region. This requires the **IP Prefixes Write** permission in addition to **DLS Write**, because the binding is created against a BYOIP prefix in Addressing.
POST /accounts/{account_id}/dls/regional_services/prefix_bindings - Write
Update a DLS prefix binding
Update the region of an existing BYOIP prefix binding. Like creating a binding, this requires **IP Prefixes Write** in addition to **DLS Write**.
PATCH /accounts/{account_id}/dls/regional_services/prefix_bindings/{binding_id} - Destructive
Delete a DLS prefix binding
Delete a BYOIP prefix binding. Like creating a binding, this requires **IP Prefixes Write** in addition to **DLS Write**.
DELETE /accounts/{account_id}/dls/regional_services/prefix_bindings/{binding_id}
Regions
- Read
List DLS regions for an account
List the DLS regions (managed and custom) available to an account.
GET /accounts/{account_id}/dls/regions - Read
Get a DLS region
Retrieve a single DLS region (managed or custom) by ID or region key.
GET /accounts/{account_id}/dls/regions/{region_id}
DNS Firewall
- Read
List DNS Firewall Clusters
List DNS Firewall clusters for an account
GET /accounts/{account_id}/dns_firewall - Read
DNS Firewall Cluster Details
Show a single DNS Firewall cluster for an account
GET /accounts/{account_id}/dns_firewall/{dns_firewall_id} - Read
Show DNS Firewall Cluster Reverse DNS
Show reverse DNS configuration (PTR records) for a DNS Firewall cluster
GET /accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns - Write
Create DNS Firewall Cluster
Create a DNS Firewall cluster
POST /accounts/{account_id}/dns_firewall - Write
Update DNS Firewall Cluster
Modify the configuration of a DNS Firewall cluster
PATCH /accounts/{account_id}/dns_firewall/{dns_firewall_id} - Write
Update DNS Firewall Cluster Reverse DNS
Update reverse DNS configuration (PTR records) for a DNS Firewall cluster
PATCH /accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns - Destructive
Delete DNS Firewall Cluster
Delete a DNS Firewall cluster
DELETE /accounts/{account_id}/dns_firewall/{dns_firewall_id}
DNS Firewall Analytics
- Read
Table (deprecated)
Retrieves a list of summarised aggregate metrics over a given time period. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
GET /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report - Read
By Time (deprecated)
Retrieves a list of aggregate metrics grouped by time interval. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
GET /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime
DNS Records for an Account
- Read
Get DNS Record Usage for Account
Get the current DNS record usage and quota for an account. May include internal DNS usage and quota.
GET /accounts/{account_id}/dns_records/usage
DNS Settings for an Account
- Read
Show DNS Settings
Show DNS settings for an account
GET /accounts/{account_id}/dns_settings - Write
Update DNS Settings
Update DNS settings for an account
PATCH /accounts/{account_id}/dns_settings
Custom Nameserver Sets for an Account
- Read
List Custom Nameserver Sets
Lists an account's Custom Nameserver Sets.
GET /accounts/{account_id}/dns_settings/nameserver_sets - Read
Get Custom Nameserver Set
Gets a Custom Nameserver Set owned by an account.
GET /accounts/{account_id}/dns_settings/nameserver_sets/{nameserver_set_id} - Write
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.
POST /accounts/{account_id}/dns_settings/nameserver_sets - Write
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.
PATCH /accounts/{account_id}/dns_settings/nameserver_sets/{nameserver_set_id} - Destructive
Delete Custom Nameserver Set
Deletes an unassigned Custom Nameserver Set.
DELETE /accounts/{account_id}/dns_settings/nameserver_sets/{nameserver_set_id}
DNS Internal Views for an Account
- Read
List Internal DNS Views
List DNS Internal Views for an Account
GET /accounts/{account_id}/dns_settings/views - Read
DNS Internal View Details
Get DNS Internal View
GET /accounts/{account_id}/dns_settings/views/{view_id} - Write
Create Internal DNS View
Create Internal DNS View for an account
POST /accounts/{account_id}/dns_settings/views - Write
Update Internal DNS View
Update an existing Internal DNS View
PATCH /accounts/{account_id}/dns_settings/views/{view_id} - Destructive
Delete Internal DNS View
Delete an existing Internal DNS View
DELETE /accounts/{account_id}/dns_settings/views/{view_id}
Email Security Analytics
- Read
Get monthly report
Returns an aggregated monthly email security report including detections, dispositions, and policy activity for the trailing 12 months.
GET /accounts/{account_id}/email-security/analytics/monthly_report
Email Security
- Read
Search email messages
Returns information for each email that matches the provided search parameters.
GET /accounts/{account_id}/email-security/investigate - Read
List bulk action jobs
Returns a paginated list of bulk action jobs for the account.
GET /accounts/{account_id}/email-security/investigate/bulk - Read
Get bulk action job details
Returns the status and details of a specific bulk action job.
GET /accounts/{account_id}/email-security/investigate/bulk/{job_id} - Read
List messages for a bulk action job
Returns the individual messages associated with a bulk action job, including their processing status.
GET /accounts/{account_id}/email-security/investigate/bulk/{job_id}/messages - Read
Get message details
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.
GET /accounts/{account_id}/email-security/investigate/{investigate_id} - Read
List post-delivery actions for a message
Returns the list of post-delivery actions (moves, quarantine releases, previews, etc.) that have been applied to a specific email message.
GET /accounts/{account_id}/email-security/investigate/{investigate_id}/action_log - Read
Get message detection details
Returns detection details such as threat categories and sender information for messages with a detection.
GET /accounts/{account_id}/email-security/investigate/{investigate_id}/detections - Read
Get preview for a detection
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.
GET /accounts/{account_id}/email-security/investigate/{investigate_id}/preview - Read
Get raw email content
Returns the raw EML content of any message with a detection.
GET /accounts/{account_id}/email-security/investigate/{investigate_id}/raw - Read
Get email 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.
GET /accounts/{account_id}/email-security/investigate/{investigate_id}/trace - Read
List 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.
GET /accounts/{account_id}/email-security/phishguard/reports - Read
List reclassify 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.
GET /accounts/{account_id}/email-security/submissions - Write
Create a bulk action 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.
POST /accounts/{account_id}/email-security/investigate/bulk - Write
Move messages
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.
POST /accounts/{account_id}/email-security/investigate/move - Write
Generate preview for a non-detection message
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.
POST /accounts/{account_id}/email-security/investigate/preview - Write
Release messages from quarantine
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.
POST /accounts/{account_id}/email-security/investigate/release - Write
Move a message
Moves a single message to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration.
POST /accounts/{account_id}/email-security/investigate/{investigate_id}/move - Write
Change email classification (deprecated)
Submits a request to reclassify an email's disposition. Use for reporting false positives or false negatives. Optionally provide the raw EML content for reanalysis. The reclassification is processed asynchronously. Deprecated; use the create submissions endpoint instead.
POST /accounts/{account_id}/email-security/investigate/{investigate_id}/reclassify - Write
Create new submissions
Submits messages for reclassification or to report missed detections.
POST /accounts/{account_id}/email-security/submissions - Destructive
Delete a bulk action 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.
DELETE /accounts/{account_id}/email-security/investigate/bulk/{job_id} - Destructive
Cancel a bulk action job
Cancels the job, marking it as cancelled and stopping any pending message processing. The job record remains visible in list and detail endpoints.
POST /accounts/{account_id}/email-security/investigate/bulk/{job_id}/cancel
Email Security Settings
- Read
List email 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.
GET /accounts/{account_id}/email-security/settings/allow_policies - Read
Get an email allow policy
Retrieves details for a specific allow policy including its pattern, dispositions that are exempted, and whether it applies to all detections.
GET /accounts/{account_id}/email-security/settings/allow_policies/{policy_id} - Read
List blocked email 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.
GET /accounts/{account_id}/email-security/settings/block_senders - Read
Get a blocked email sender
Retrieves details for a specific blocked sender pattern including its pattern type, value, and metadata.
GET /accounts/{account_id}/email-security/settings/block_senders/{pattern_id} - Read
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.
GET /accounts/{account_id}/email-security/settings/content_policies - Read
Get a content policy
Retrieves details for a specific content policy including its pattern, targets, and metadata.
GET /accounts/{account_id}/email-security/settings/content_policies/{policy_id} - Read
List protected email 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.
GET /accounts/{account_id}/email-security/settings/domains - Read
Get an email domain
Retrieves detailed information for a specific protected email domain including its delivery configuration, SPF/DMARC status, and authorization state.
GET /accounts/{account_id}/email-security/settings/domains/{domain_id} - Read
Get domain verification details
Returns the DNS TXT record information when the domain ownership isn't verified through Cloudflare zone ownership or CASB integration.
GET /accounts/{account_id}/email-security/settings/domains/{domain_id}/verification - Read
List impersonation registry entries
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.
GET /accounts/{account_id}/email-security/settings/impersonation_registry - Read
Get an impersonation registry entry
Retrieves details for a specific impersonation registry entry including the protected identity, email pattern, and synchronization source if directory-synced.
GET /accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id} - Read
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.
GET /accounts/{account_id}/email-security/settings/sending_domain_restrictions - Read
Get a 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.
GET /accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id} - Read
List trusted email 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.
GET /accounts/{account_id}/email-security/settings/trusted_domains - Read
Get a trusted email domain
Retrieves details for a specific trusted domain pattern including its pattern value, whether it uses regex matching, and which detection types it affects.
GET /accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id} - Read
List URL ignore patterns
Returns a paginated list of URL rewrite ignore patterns for the account. URLs matching these patterns will not be rewritten.
GET /accounts/{account_id}/email-security/settings/url_ignore_patterns - Read
Get a URL ignore pattern
Returns a single URL rewrite ignore pattern by its identifier.
GET /accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id} - Write
Create email 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.
POST /accounts/{account_id}/email-security/settings/allow_policies - Write
Create blocked email 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.
POST /accounts/{account_id}/email-security/settings/block_senders - Write
Update a blocked email sender
Updates an existing blocked sender pattern. Only provided fields will be modified. The pattern will continue blocking emails until deleted.
PATCH /accounts/{account_id}/email-security/settings/block_senders/{pattern_id} - Write
Create a content policy
Creates a new content policy. Emails whose subject or body matches the pattern will be subject to the configured action.
POST /accounts/{account_id}/email-security/settings/content_policies - Write
Add a new email domain
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.
POST /accounts/{account_id}/email-security/settings/domains - Write
Update an email domain
Updates configuration for a protected email domain. Only provided fields will be modified. Changes affect delivery mode, security settings, and regional processing.
PATCH /accounts/{account_id}/email-security/settings/domains/{domain_id} - Write
Create impersonation registry entry
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.
POST /accounts/{account_id}/email-security/settings/impersonation_registry - Write
Update an impersonation registry entry
Updates an existing impersonation registry entry. Only provided fields will be modified. Directory-synced entries can't be updated.
PATCH /accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id} - Write
Create a 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.
POST /accounts/{account_id}/email-security/settings/sending_domain_restrictions - Write
Update a sending domain restriction
Updates an existing sending domain restriction. Only provided fields will be modified. Changes affect which domains require TLS and which subdomains are excluded.
PATCH /accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id} - Write
Create trusted email 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.
POST /accounts/{account_id}/email-security/settings/trusted_domains - Write
Update a trusted email domain
Updates an existing trusted domain pattern. Only provided fields will be modified. Changes take effect for new emails matching the pattern.
PATCH /accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id} - Write
Create a URL ignore pattern
Creates a new URL rewrite ignore pattern. URLs matching this pattern will not be rewritten.
POST /accounts/{account_id}/email-security/settings/url_ignore_patterns - Write
Update a URL ignore pattern
Updates an existing URL rewrite ignore pattern. Only provided fields will be modified.
PATCH /accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id} - Destructive
Batch allow policy operations
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.
POST /accounts/{account_id}/email-security/settings/allow_policies/batch - Destructive
Delete an email allow policy
Removes an allow policy. After deletion, emails matching this pattern will be subject to normal security scanning and disposition actions.
DELETE /accounts/{account_id}/email-security/settings/allow_policies/{policy_id} - Destructive
Update an email allow policy
Updates an existing allow policy. Only provided fields will be modified. Changes take effect for new emails matching the pattern.
PATCH /accounts/{account_id}/email-security/settings/allow_policies/{policy_id} - Destructive
Replace an email 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.
PUT /accounts/{account_id}/email-security/settings/allow_policies/{policy_id} - Destructive
Batch blocked sender operations
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.
POST /accounts/{account_id}/email-security/settings/block_senders/batch - Destructive
Delete a blocked email sender
Removes a blocked sender pattern. After deletion, emails from this sender will no longer be automatically blocked based on this rule.
DELETE /accounts/{account_id}/email-security/settings/block_senders/{pattern_id} - Destructive
Replace a blocked email 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.
PUT /accounts/{account_id}/email-security/settings/block_senders/{pattern_id} - Destructive
Batch content policy operations
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.
POST /accounts/{account_id}/email-security/settings/content_policies/batch - Destructive
Delete a content policy
Removes a content policy. After deletion, emails will no longer be evaluated against this pattern.
DELETE /accounts/{account_id}/email-security/settings/content_policies/{policy_id} - Destructive
Update a content policy
Updates an existing content policy. Only provided fields will be modified.
PATCH /accounts/{account_id}/email-security/settings/content_policies/{policy_id} - Destructive
Unprotect multiple email domains (deprecated)
Removes protection from multiple email domains. Deprecated; use the batch endpoint instead.
DELETE /accounts/{account_id}/email-security/settings/domains - Destructive
Batch domain operations
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.
POST /accounts/{account_id}/email-security/settings/domains/batch - Destructive
Unprotect an email 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.
DELETE /accounts/{account_id}/email-security/settings/domains/{domain_id} - Destructive
Replace an email domain
Replaces all mutable fields of a protected email domain in a single atomic operation. Unlike PATCH, all non-computed fields are required.
PUT /accounts/{account_id}/email-security/settings/domains/{domain_id} - Destructive
Delete an impersonation registry entry
Removes an entry from the impersonation registry. After deletion, this identity will no longer be protected from impersonation.
DELETE /accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id} - Destructive
Batch sending domain restriction operations
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.
POST /accounts/{account_id}/email-security/settings/sending_domain_restrictions/batch - Destructive
Delete a sending domain restriction
Removes a sending domain restriction. After deletion, TLS will no longer be enforced for emails from this domain.
DELETE /accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id} - Destructive
Batch trusted domain operations
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.
POST /accounts/{account_id}/email-security/settings/trusted_domains/batch - Destructive
Delete a trusted email domain
Removes a trusted domain pattern. After deletion, emails from this domain will be subject to normal recent domain and similarity checks.
DELETE /accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id} - Destructive
Replace a trusted email 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.
PUT /accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id} - Destructive
Batch URL ignore pattern operations
Executes multiple operations atomically. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.
POST /accounts/{account_id}/email-security/settings/url_ignore_patterns/batch - Destructive
Delete a URL ignore pattern
Removes a URL rewrite ignore pattern. After deletion, URLs matching this pattern will be rewritten again.
DELETE /accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}
Email for Platforms
- Read
List Email Domain 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.
GET /accounts/{account_id}/email/domain-changes - Read
List Email Domains
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.
GET /accounts/{account_id}/email/domains - Read
Get an Email Domain
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.
GET /accounts/{account_id}/email/domains/{email_domain_id} - Write
Create an Email Domain
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.
POST /accounts/{account_id}/email/domains - Write
Verify an Email Domain
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.
POST /accounts/{account_id}/email/domains/{email_domain_id}/verify - Destructive
Delete an Email Domain
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.
DELETE /accounts/{account_id}/email/domains/{email_domain_id}
Email Routing destination addresses
- Read
List destination addresses
Lists destination addresses configured for Email Routing in an account.
GET /accounts/{account_id}/email/routing/addresses - Read
Get a destination address
Gets information for a specific destination email already created.
GET /accounts/{account_id}/email/routing/addresses/{destination_address_identifier} - Write
Create a destination address
Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.
POST /accounts/{account_id}/email/routing/addresses - Write
Update destination address
Updates the status of a specific destination address.
PATCH /accounts/{account_id}/email/routing/addresses/{destination_address_identifier} - Destructive
Delete destination address
Deletes a specific destination address.
DELETE /accounts/{account_id}/email/routing/addresses/{destination_address_identifier}
Email Routing routing rules
- Read
List account routing rules
Lists existing routing rules across all zones in the account.
GET /accounts/{account_id}/email/routing/rules - Read
Plan account routing rule changes
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.
POST /accounts/{account_id}/email/routing/rules/plan - Read
List routing rules
Lists the routing rules that match incoming messages for a zone.
GET /zones/{zone_id}/email/routing/rules - Read
Get catch-all rule
Get information on the default catch-all routing rule.
GET /zones/{zone_id}/email/routing/rules/catch_all - Read
Get routing rule
Get information for a specific routing rule already created.
GET /zones/{zone_id}/email/routing/rules/{rule_identifier} - Write
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.
POST /zones/{zone_id}/email/routing/rules - Destructive
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.
PUT /zones/{zone_id}/email/routing/rules/catch_all - Destructive
Delete routing rule
Deletes a routing rule so matching incoming messages are no longer forwarded by it.
DELETE /zones/{zone_id}/email/routing/rules/{rule_identifier} - Destructive
Update routing rule
Update actions and matches, or enable/disable specific routing rules. Forward actions require exactly one verified destination address.
PUT /zones/{zone_id}/email/routing/rules/{rule_identifier}
Email Routing suppressions
- Read
List account email suppressions (deprecated)
Lists email suppressions for the specified account.
GET /accounts/{account_id}/email/routing/suppression - Read
Get account email suppression (deprecated)
Retrieves a single email suppression for the specified account.
GET /accounts/{account_id}/email/routing/suppression/{suppression_id} - Read
List zone email suppressions (deprecated)
Lists email suppressions for the specified zone.
GET /zones/{zone_id}/email/routing/suppression - Read
Get zone email suppression (deprecated)
Retrieves a single email suppression for the specified zone.
GET /zones/{zone_id}/email/routing/suppression/{suppression_id} - Write
Create account email suppression (deprecated)
Creates a new email suppression for the specified account.
POST /accounts/{account_id}/email/routing/suppression - Write
Create zone email suppression (deprecated)
Creates a new email suppression for the specified zone.
POST /zones/{zone_id}/email/routing/suppression - Destructive
Delete account email suppression (deprecated)
Deletes an email suppression for the specified account.
DELETE /accounts/{account_id}/email/routing/suppression/{suppression_id} - Destructive
Delete zone email suppression (deprecated)
Deletes an email suppression for the specified zone.
DELETE /zones/{zone_id}/email/routing/suppression/{suppression_id}
Email Sending
- Read
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.
GET /accounts/{account_id}/email/sending/limits - Read
Fetch an email message
Returns the raw RFC 5322 MIME message for the given account and message id.
GET /accounts/{account_id}/email/sending/messages/{message_id} - Read
Get account reputation
Returns the authoritative Email Sending reputation state and active evaluation policy. Accounts without an evaluation are Healthy with null evaluation timestamps.
GET /accounts/{account_id}/email/sending/reputation - Write
Send an email
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.
POST /accounts/{account_id}/email/sending/send - Write
Send a raw MIME email
Send a raw RFC 5322 (MIME) email for the specified account. Provide the full MIME message plus the SMTP envelope (from and recipients).
POST /accounts/{account_id}/email/sending/send_raw
Email Sending suppressions
- Read
List account email suppressions (deprecated)
Lists email suppressions for the specified account.
GET /accounts/{account_id}/email/sending/suppression - Read
Get account email suppression (deprecated)
Retrieves a single email suppression for the specified account.
GET /accounts/{account_id}/email/sending/suppression/{suppression_id} - Read
List account Email Sending suppressions
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.
GET /accounts/{account_id}/email/sending/suppressions - Read
Get account Email Sending suppression
Gets an Email Sending suppression owned by the account.
GET /accounts/{account_id}/email/sending/suppressions/{suppression_id} - Read
List zone email suppressions (deprecated)
Lists email suppressions for the specified zone.
GET /zones/{zone_id}/email/sending/suppression - Read
Get zone email suppression (deprecated)
Retrieves a single email suppression for the specified zone.
GET /zones/{zone_id}/email/sending/suppression/{suppression_id} - Write
Create account email suppression (deprecated)
Creates a new email suppression for the specified account.
POST /accounts/{account_id}/email/sending/suppression - Write
Create account Email Sending suppression
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.
POST /accounts/{account_id}/email/sending/suppressions - Write
Bulk import account Email Sending suppressions
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.
POST /accounts/{account_id}/email/sending/suppressions/bulk - Write
Create zone email suppression (deprecated)
Creates a new email suppression for the specified zone.
POST /zones/{zone_id}/email/sending/suppression - Destructive
Delete account email suppression (deprecated)
Deletes an email suppression for the specified account.
DELETE /accounts/{account_id}/email/sending/suppression/{suppression_id} - Destructive
Delete account Email Sending suppression
Deletes the suppression, its note, and every legacy internal zone membership, allowing future delivery attempts to the address.
DELETE /accounts/{account_id}/email/sending/suppressions/{suppression_id} - Destructive
Update account Email Sending suppression
Updates expiry or advisory note fields without changing legacy internal zone memberships. Scope cannot be changed.
PATCH /accounts/{account_id}/email/sending/suppressions/{suppression_id} - Destructive
Delete zone email suppression (deprecated)
Deletes an email suppression for the specified zone.
DELETE /zones/{zone_id}/email/sending/suppression/{suppression_id}
Account Entitlements
- Read
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.
GET /accounts/{account_id}/entitlements
R2 Bucket
- Read
List Event Notification Rules
Lists event notification rules for an R2 bucket, grouped by the Cloudflare Queue that receives matching object events.
GET /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration - Read
Get Event Notification Rules for a Queue
Gets the event notification rules for the specified R2 bucket and Cloudflare Queue. The response includes the queue's configuration and its array of rules.
GET /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id} - Read
List Buckets
Lists a page of R2 buckets in the account and selected jurisdiction. Use the returned cursor to retrieve the next page.
GET /accounts/{account_id}/r2/buckets - Read
Get Bucket
Gets properties of an existing R2 bucket.
GET /accounts/{account_id}/r2/buckets/{bucket_name} - Read
Get Bucket CORS Policy
Get the CORS policy for a bucket.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/cors - Read
List Custom Domains of Bucket
Gets a list of all custom domains registered with an existing R2 bucket.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom - Read
Get Custom Domain Settings
Get the configuration for a custom domain on an existing R2 bucket.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain} - Read
Get r2.dev Domain of Bucket
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.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed - Read
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.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/jobs - Read
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`.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/jobs/{job_id} - Read
Get Object Lifecycle Rules
Get object lifecycle rules for a bucket.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/lifecycle - Read
Get 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.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/local-uploads - Read
Get Bucket Lock Rules
Get lock rules for a bucket.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/lock - Read
Get Sippy Configuration
Gets configuration for Sippy for an existing R2 bucket.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/sippy - Write
Create Bucket
Creates an R2 bucket in the account and selected jurisdiction, with an optional location hint and default storage class.
POST /accounts/{account_id}/r2/buckets - Write
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.
PATCH /accounts/{account_id}/r2/buckets/{bucket_name} - Write
Attach Custom Domain To Bucket
Register a new custom domain for an existing R2 bucket.
POST /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom - Write
Create Temporary Access Credentials
Creates temporary access credentials on a bucket that can be optionally scoped to prefixes or objects.
POST /accounts/{account_id}/r2/temp-access-credentials - Destructive
Delete Event Notification Rules
Deletes the specified event notification rules for an R2 bucket and Cloudflare Queue. Provide ruleIds in the request body to select rules. If no body is provided, all rules for that bucket and queue are deleted.
DELETE /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id} - Destructive
Create Event Notification Rules
Creates rules that send notifications for matching R2 object events to the specified Cloudflare Queue. Rules can filter objects by key prefix and suffix. New rules are added to any existing rules for the queue; a rule that overlaps an existing rule is rejected.
PUT /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id} - Destructive
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.
DELETE /accounts/{account_id}/r2/buckets/{bucket_name} - Destructive
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`.
PUT /accounts/{account_id}/r2/buckets/{bucket_name} - Destructive
Delete Bucket CORS Policy
Delete the CORS policy for a bucket.
DELETE /accounts/{account_id}/r2/buckets/{bucket_name}/cors - Destructive
Set 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.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/cors - Destructive
Remove Custom Domain From Bucket
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.
DELETE /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain} - Destructive
Configure Custom Domain Settings
Edit the configuration for a custom domain on an existing R2 bucket.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain} - Destructive
Update r2.dev Domain of Bucket
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.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed - Destructive
Create Bucket Job
Creates a background job for an R2 bucket. The `jobType` field selects the job: - **`prefixDelete`**: deletes every object whose key begins with `prefix`. A non-empty prefix must end in `/`. An empty prefix (`""`) empties the entire bucket. - **`storageClassMigration`**: migrates every object in the bucket between storage classes. `sourceStorageClass` and `destinationStorageClass` must be provided together and must differ; omitting both migrates from `InfrequentAccess` to `Standard`. Poll the returned `id` with the Get Bucket Job endpoint. Small prefix-delete jobs can finish synchronously and return `COMPLETED`. Objects uploaded after a background job starts are not affected by that job. For prefix-delete jobs: abort active multipart uploads before submitting the request, since a synchronously completed job does not abort them, and avoid writing objects or starting multipart uploads while a bucket-emptying job is in progress. Each request creates a distinct job, and the number of active prefix-delete jobs is limited per bucket; wait for an existing job to finish before retrying a request rejected with HTTP 429. A bucket cannot be emptied while event notifications are configured (HTTP 409 / error code 10083). To protect a bucket with R2 Data Catalog enabled, send the `cf-r2-data-catalog-check` header; a conflict is returned with HTTP 409 / error code 10081. Prefix-delete jobs require permission to delete objects; storage-class migration jobs require permission to write to the bucket.
POST /accounts/{account_id}/r2/buckets/{bucket_name}/jobs - Destructive
Set Object Lifecycle Rules
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.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/lifecycle - Destructive
Set 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.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/local-uploads - Destructive
Delete Bucket Lock Rules
Delete all lock rules for a bucket.
DELETE /accounts/{account_id}/r2/buckets/{bucket_name}/lock - Destructive
Set Bucket Lock Rules
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.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/lock - Destructive
Disable Sippy
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.
DELETE /accounts/{account_id}/r2/buckets/{bucket_name}/sippy - Destructive
Enable Sippy
Configures and enables Sippy on-demand migration for an R2 bucket. When a requested object is missing from R2, Sippy serves it from the configured source storage provider and copies it to R2.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/sippy
Queue
- Read
List Event Subscriptions
Returns a paginated list of Queue event subscriptions with optional sorting and filtering.
GET /accounts/{account_id}/event_subscriptions/subscriptions - Read
Get Event Subscription
Returns an existing Queue event subscription.
GET /accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id} - Read
List Queues
Returns the queues owned by an account.
GET /accounts/{account_id}/queues - Read
Get Queue
Returns details about a specific Queue.
GET /accounts/{account_id}/queues/{queue_id} - Read
List Queue Consumers
Returns the consumers configured for a Queue.
GET /accounts/{account_id}/queues/{queue_id}/consumers - Read
Get Queue Consumer
Returns a Queue consumer by identifier.
GET /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id} - Read
Get Queue Metrics
Returns best-effort metrics for a Queue. Values may be approximate due to the distributed nature of Queues.
GET /accounts/{account_id}/queues/{queue_id}/metrics - Read
Get Queue Purge Status
Returns the status of a Queue purge operation.
GET /accounts/{account_id}/queues/{queue_id}/purge - Write
Create Event Subscription
Creates an event subscription for a Queue.
POST /accounts/{account_id}/event_subscriptions/subscriptions - Write
Update Event Subscription
Updates an existing Queue event subscription.
PATCH /accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id} - Write
Create Queue
Creates a Queue in the account.
POST /accounts/{account_id}/queues - Write
Update Queue
Updates part of a Queue's configuration.
PATCH /accounts/{account_id}/queues/{queue_id} - Write
Create a Queue Consumer
Creates a consumer for a Queue.
POST /accounts/{account_id}/queues/{queue_id}/consumers - Write
Push Message
Pushes a message to a Queue.
POST /accounts/{account_id}/queues/{queue_id}/messages - Write
Acknowledge + Retry Queue Messages
Acknowledges successfully processed Queue messages and retries messages that were not processed successfully.
POST /accounts/{account_id}/queues/{queue_id}/messages/ack - Write
Push Message Batch
Pushes a batch of messages to a Queue.
POST /accounts/{account_id}/queues/{queue_id}/messages/batch - Write
Extend Message Leases
Extends message leases without incrementing the messages' `attempts` counters. Each message receives a new lease identifier.
POST /accounts/{account_id}/queues/{queue_id}/messages/extend - Write
Peek Queue 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.
POST /accounts/{account_id}/queues/{queue_id}/messages/peek - Write
Preview Queue Messages (deprecated)
Preview messages from a Queue without leasing them. This deprecated route is retained for compatibility; use the peek endpoint for new integrations.
POST /accounts/{account_id}/queues/{queue_id}/messages/preview - Write
Pull Queue Messages
Pulls a batch of messages from a Queue for an HTTP pull consumer.
POST /accounts/{account_id}/queues/{queue_id}/messages/pull - Destructive
Delete Event Subscription
Deletes an existing Queue event subscription.
DELETE /accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id} - Destructive
Delete Queue
Deletes a Queue.
DELETE /accounts/{account_id}/queues/{queue_id} - Destructive
Update Queue
Replaces a Queue's configuration with the supplied configuration. This endpoint does not support partial updates.
PUT /accounts/{account_id}/queues/{queue_id} - Destructive
Delete Queue Consumer
Deletes a consumer from a Queue.
DELETE /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id} - Destructive
Update Queue Consumer
Replaces a Queue consumer, or creates it if it does not exist.
PUT /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id} - Destructive
Delete Previewed Queue Messages (deprecated)
Delete messages returned by the legacy preview endpoint. This deprecated route is retained for compatibility; use the peek and purge endpoints for new integrations. Deleting messages this way does not count as delivery and does not affect metrics.
POST /accounts/{account_id}/queues/{queue_id}/messages/preview/ack - Destructive
Purge Peeked Queue 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.
POST /accounts/{account_id}/queues/{queue_id}/messages/purge - Destructive
Purge Queue
Starts a purge that deletes all messages from a Queue.
POST /accounts/{account_id}/queues/{queue_id}/purge
Field Extractors
- Read
Get Field Extractor
Retrieves the custom extraction rules configured for a given extractor type.
GET /accounts/{account_id}/field_extractors/{extractor} - Destructive
Delete Field Extractor
Deletes all custom extraction rules for an extractor type.
DELETE /accounts/{account_id}/field_extractors/{extractor} - Destructive
Update Field Extractor
Replaces all custom extraction rules for an extractor type. Omitted rules are deleted.
PUT /accounts/{account_id}/field_extractors/{extractor}
IP Access rules for an account
- Read
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.
GET /accounts/{account_id}/firewall/access_rules/rules - Read
Get an IP Access rule
Fetches the details of an IP Access rule defined at the account level.
GET /accounts/{account_id}/firewall/access_rules/rules/{rule_id} - Write
Create an IP Access rule
Creates a new IP Access rule for an account. The rule will apply to all zones in the account. Note: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.
POST /accounts/{account_id}/firewall/access_rules/rules - Write
Update an IP Access rule
Updates an IP Access rule defined at the account level. Note: This operation will affect all zones in the account.
PATCH /accounts/{account_id}/firewall/access_rules/rules/{rule_id} - Destructive
Delete an IP Access rule
Deletes an existing IP Access rule defined at the account level. Note: This operation will affect all zones in the account.
DELETE /accounts/{account_id}/firewall/access_rules/rules/{rule_id}
Payload logging keys for an account
- Read
Get the payload logging key
Fetches the public key that payload logging uses to encrypt matched payloads for the account.
GET /accounts/{account_id}/firewall/payload_logging/key - Destructive
Delete the payload logging key
Deletes the payload logging public key of the account.
DELETE /accounts/{account_id}/firewall/payload_logging/key - Destructive
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.
PUT /accounts/{account_id}/firewall/payload_logging/key
Apps
- Read
List apps
Lists all Flagship apps in the account. Returns identity and audit fields only; flag definitions are not included.
GET /accounts/{account_id}/flagship/apps - Read
Get app
Returns an app's name and audit fields. Flag definitions are not included.
GET /accounts/{account_id}/flagship/apps/{app_id} - Read
Fetch all apps
Fetch all apps for your account
GET /accounts/{account_id}/realtime/kit/apps - Read
Fetch app details
Fetch details for an app in your account.
GET /accounts/{account_id}/realtime/kit/apps/{app_id} - Write
Create app
Creates an app. The returned `id` is used in all subsequent flag, changelog, and evaluation requests.
POST /accounts/{account_id}/flagship/apps - Write
Create App
Create new app for your account
POST /accounts/{account_id}/realtime/kit/apps - Write
Update an app
Update the name of an app in your account.
PATCH /accounts/{account_id}/realtime/kit/apps/{app_id} - Destructive
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.
DELETE /accounts/{account_id}/flagship/apps/{app_id} - Destructive
Update app
Updates an app. Only `name` is mutable.
PUT /accounts/{account_id}/flagship/apps/{app_id}
Definitions
- Read
Get flag 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.
GET /accounts/{account_id}/flagship/apps/{app_id}/definitions
Evaluation
- Read
Evaluate flag from query context
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.
GET /accounts/{account_id}/flagship/apps/{app_id}/evaluate - Write
Evaluate flag with JSON context
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.
POST /accounts/{account_id}/flagship/apps/{app_id}/evaluate
Flags
- Read
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.
GET /accounts/{account_id}/flagship/apps/{app_id}/flags - Read
Get flag
Returns the full flag definition including rules, variations, metadata, and audit fields.
GET /accounts/{account_id}/flagship/apps/{app_id}/flags/{flag_key} - Write
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.
POST /accounts/{account_id}/flagship/apps/{app_id}/flags - Destructive
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.
DELETE /accounts/{account_id}/flagship/apps/{app_id}/flags/{flag_key} - Destructive
Partially update 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.
PATCH /accounts/{account_id}/flagship/apps/{app_id}/flags/{flag_key} - Destructive
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.
PUT /accounts/{account_id}/flagship/apps/{app_id}/flags/{flag_key}
Changelog
- Read
List flag changelog entries
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.
GET /accounts/{account_id}/flagship/apps/{app_id}/flags/{flag_key}/changelog
Zero Trust Gateway application and application type mappings
- Read
List application and application type mappings
List all application and application type mappings.
GET /accounts/{account_id}/gateway/app_types
Zero Trust applications review status
- Read
List applications review statuses
Retrieve the statuses of your applications.
GET /accounts/{account_id}/gateway/apps/review_status - Destructive
Update applications review statuses
Update the statuses of your applications.
PUT /accounts/{account_id}/gateway/apps/review_status
Zero Trust SSH Settings
- Read
Get Zero Trust SSH settings
Retrieve SSH with Access for Infrastructure settings for an account.
GET /accounts/{account_id}/gateway/audit_ssh_settings - Write
Rotate Zero Trust SSH account seed
Rotate the SSH account seed that generates the host key identity when connecting through the Cloudflare SSH Proxy.
POST /accounts/{account_id}/gateway/audit_ssh_settings/rotate_seed - Destructive
Update Zero Trust SSH settings
Update SSH with Access for Infrastructure settings for an account.
PUT /accounts/{account_id}/gateway/audit_ssh_settings
Zero Trust Gateway categories
- Read
List categories
List all categories.
GET /accounts/{account_id}/gateway/categories
Zero Trust certificates
- Read
List Zero Trust certificates
List all Zero Trust certificates for an account.
GET /accounts/{account_id}/gateway/certificates - Read
Get Zero Trust certificate details
Get a single Zero Trust certificate.
GET /accounts/{account_id}/gateway/certificates/{certificate_id} - Write
Create Zero Trust certificate
Create a new Zero Trust certificate.
POST /accounts/{account_id}/gateway/certificates - Write
Activate a Zero Trust certificate
Bind a single Zero Trust certificate to the edge.
POST /accounts/{account_id}/gateway/certificates/{certificate_id}/activate - Write
Deactivate a Zero Trust certificate
Unbind a single Zero Trust certificate from the edge.
POST /accounts/{account_id}/gateway/certificates/{certificate_id}/deactivate - Destructive
Delete Zero Trust certificate
Delete a gateway-managed Zero Trust certificate. You must deactivate the certificate from the edge (inactive) before deleting it.
DELETE /accounts/{account_id}/gateway/certificates/{certificate_id}
Zero Trust Gateway DNS destination IPv4 address pairs
- Read
List Zero Trust Gateway DNS destination IPv4 address pairs
List Zero Trust Gateway IPv4 address pairs for an account.
GET /accounts/{account_id}/gateway/dns_destination_ips
Zero Trust lists
- Read
List Zero Trust lists
Fetch all Zero Trust lists for an account.
GET /accounts/{account_id}/gateway/lists - Read
Get Zero Trust list details
Fetch a single Zero Trust list.
GET /accounts/{account_id}/gateway/lists/{list_id} - Read
Get Zero Trust list items
Fetch all items in a single Zero Trust list.
GET /accounts/{account_id}/gateway/lists/{list_id}/items - Write
Create Zero Trust list
Creates a new Zero Trust list.
POST /accounts/{account_id}/gateway/lists - Write
Create Zero Trust list from CSV
Create a new Zero Trust list by uploading a CSV file. The file must be `text/csv` or `text/plain` and cannot exceed 2 MB. The operation is processed asynchronously. Use the returned operation ID to poll for status.
POST /accounts/{account_id}/gateway/lists/upload - Destructive
Delete Zero Trust list
Deletes a Zero Trust list.
DELETE /accounts/{account_id}/gateway/lists/{list_id} - Destructive
Patch Zero Trust list.
Appends or removes an item from a configured Zero Trust list.
PATCH /accounts/{account_id}/gateway/lists/{list_id} - Destructive
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.
PUT /accounts/{account_id}/gateway/lists/{list_id}
Zero Trust Gateway locations
- Read
List Zero Trust Gateway locations
List Zero Trust Gateway locations for an account.
GET /accounts/{account_id}/gateway/locations - Read
Get Zero Trust Gateway location details
Get a single Zero Trust Gateway location.
GET /accounts/{account_id}/gateway/locations/{location_id} - Write
Create a Zero Trust Gateway location
Create a new Zero Trust Gateway location.
POST /accounts/{account_id}/gateway/locations - Destructive
Delete a Zero Trust Gateway location
Delete a configured Zero Trust Gateway location.
DELETE /accounts/{account_id}/gateway/locations/{location_id} - Destructive
Update a Zero Trust Gateway location
Update a configured Zero Trust Gateway location.
PUT /accounts/{account_id}/gateway/locations/{location_id}
Zero Trust Gateway operations
- Read
List Zero Trust Gateway operations
List all Zero Trust Gateway operations for an account.
GET /accounts/{account_id}/gateway/operations - Read
Zero Trust Gateway operation details
Fetch a single Zero Trust Gateway operation by its ID.
GET /accounts/{account_id}/gateway/operations/{operation_id}
Zero Trust Gateway PAC files
- Read
List PAC files
List all Zero Trust Gateway PAC files for an account.
GET /accounts/{account_id}/gateway/pacfiles - Read
Get a PAC file
Get a single Zero Trust Gateway PAC file.
GET /accounts/{account_id}/gateway/pacfiles/{pacfile_id} - Write
Create a PAC file
Create a new Zero Trust Gateway PAC file.
POST /accounts/{account_id}/gateway/pacfiles - Destructive
Delete a PAC file
Delete a configured Zero Trust Gateway PAC file.
DELETE /accounts/{account_id}/gateway/pacfiles/{pacfile_id} - Destructive
Update a Zero Trust Gateway PAC file
Update a configured Zero Trust Gateway PAC file.
PUT /accounts/{account_id}/gateway/pacfiles/{pacfile_id}
Zero Trust Gateway proxy endpoints
- Read
List proxy endpoints
List all Zero Trust Gateway proxy endpoints for an account.
GET /accounts/{account_id}/gateway/proxy_endpoints - Read
Get a proxy endpoint
Get a single Zero Trust Gateway proxy endpoint.
GET /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id} - Write
Create a proxy endpoint
Create a new Zero Trust Gateway proxy endpoint.
POST /accounts/{account_id}/gateway/proxy_endpoints - Write
Update a proxy endpoint
Update a configured Zero Trust Gateway proxy endpoint.
PATCH /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id} - Destructive
Delete a proxy endpoint
Delete a configured Zero Trust Gateway proxy endpoint.
DELETE /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}
Zero Trust Gateway rules
- Read
List Zero Trust Gateway rules
List Zero Trust Gateway rules for an account.
GET /accounts/{account_id}/gateway/rules - Read
List Zero Trust Gateway rules inherited from the parent account
List Zero Trust Gateway rules for the parent account of an account in the MSP configuration.
GET /accounts/{account_id}/gateway/rules/tenant - Read
Get Zero Trust Gateway rule details.
Get a single Zero Trust Gateway rule.
GET /accounts/{account_id}/gateway/rules/{rule_id} - Write
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.
PATCH /accounts/{account_id}/gateway/rules - Write
Create a Zero Trust Gateway rule
Create a new Zero Trust Gateway rule.
POST /accounts/{account_id}/gateway/rules - Write
Patch a 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.
PATCH /accounts/{account_id}/gateway/rules/{rule_id} - Write
Reset the expiration of a 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`.
POST /accounts/{account_id}/gateway/rules/{rule_id}/reset_expiration - Destructive
Delete a Zero Trust Gateway rule
Delete a Zero Trust Gateway rule.
DELETE /accounts/{account_id}/gateway/rules/{rule_id} - Destructive
Update a Zero Trust Gateway rule
Update a configured Zero Trust Gateway rule.
PUT /accounts/{account_id}/gateway/rules/{rule_id}
Hyperdrive
- Read
List Hyperdrives
Returns a list of Hyperdrives.
GET /accounts/{account_id}/hyperdrive/configs - Read
Get Hyperdrive
Returns the specified Hyperdrive configuration.
GET /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id} - Write
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.
POST /accounts/{account_id}/hyperdrive/configs - Write
Update 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.
PATCH /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id} - Write
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.
POST /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}/restart - Write
Create 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.
POST /accounts/{account_id}/hyperdrive/integrationsOperations/planetScale/createDatabaseSignature - Destructive
Delete Hyperdrive
Deletes the specified Hyperdrive.
DELETE /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id} - Destructive
Replace 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.
PUT /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}
Account Permission Groups
- Read
List Account Permission Groups
List all the permissions groups for an account.
GET /accounts/{account_id}/iam/permission_groups - Read
Permission Group Details
Get information about a specific permission group in an account.
GET /accounts/{account_id}/iam/permission_groups/{permission_group_id}
Account Resource Groups
- Read
List Resource Groups
List all the resource groups for an account.
GET /accounts/{account_id}/iam/resource_groups - Read
Resource Group Details
Get information about a specific resource group in an account.
GET /accounts/{account_id}/iam/resource_groups/{resource_group_id} - Write
Create Resource Group
Create a new Resource Group under the specified account.
POST /accounts/{account_id}/iam/resource_groups - Destructive
Remove Resource Group
Remove a resource group from an account.
DELETE /accounts/{account_id}/iam/resource_groups/{resource_group_id} - Destructive
Update Resource Group
Modify an existing resource group.
PUT /accounts/{account_id}/iam/resource_groups/{resource_group_id}
Account User Groups
- Read
List User Groups
List all the user groups for an account.
GET /accounts/{account_id}/iam/user_groups - Read
User Group Details
Get information about a specific user group in an account.
GET /accounts/{account_id}/iam/user_groups/{user_group_id} - Write
Create User Group
Create a new user group under the specified account.
POST /accounts/{account_id}/iam/user_groups - Destructive
Remove User Group
Remove a user group from an account.
DELETE /accounts/{account_id}/iam/user_groups/{user_group_id} - Destructive
Update User Group
Modify an existing user group.
PUT /accounts/{account_id}/iam/user_groups/{user_group_id}
Account User Group Members
- Read
List User Group Members
List all the members attached to a user group.
GET /accounts/{account_id}/iam/user_groups/{user_group_id}/members - Read
Get User Group Member
Get details of a specific member in a user group.
GET /accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id} - Write
Add User Group Members
Add members to a User Group.
POST /accounts/{account_id}/iam/user_groups/{user_group_id}/members - Destructive
Update User Group Members
Replace the set of members attached to a User Group.
PUT /accounts/{account_id}/iam/user_groups/{user_group_id}/members - Destructive
Remove User Group Member
Remove a member from User Group
DELETE /accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}
Cloudflare Images
- Read
List images (deprecated)
List up to 100 images with one request. Use the optional parameters below to get a specific range of images.
GET /accounts/{account_id}/images/v1 - Read
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.
GET /accounts/{account_id}/images/v1/stats - Read
Image details
Fetch details for a CF Images image.
GET /accounts/{account_id}/images/v1/{image_id} - Read
Download image
Download an image from CF Images. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original.
GET /accounts/{account_id}/images/v1/{image_id}/blob - Read
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. **Metadata Filtering (Optional):** You can optionally filter images by custom metadata fields using the `meta.<field>[<operator>]=<value>` syntax. **Supported 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 list (pipe-separated) **Metadata Filter Constraints:** - Maximum 5 metadata filters per request - Maximum 5 levels of nesting (e.g., `meta.first.second.third.fourth.fifth`) - Maximum 10 elements for list operators (`in`) - Supports string, number, and boolean value types - Range operators (`gt`, `gte`, `lt`, `lte`) only accept numeric values **Filter Consistency:** Filters are combined with AND logic. The system does not validate whether filter combinations are logically consistent. For example, `meta.priority[eq:number]=5&meta.priority[lte:number]=3` will return zero results because no value can satisfy both conditions simultaneously. It is the caller's responsibility to ensure filter combinations make sense. **Examples:** ``` # List all images /images/v2 # Filter by metadata [eq] /images/v2?meta.status[eq:string]=active # Filter by metadata [in] /images/v2?meta.status[in]=pending|deleted|flagged # Filter by metadata [in:number] /images/v2?meta.ratings[in:number]=4|5 # Filter by metadata range [gte:number] /images/v2?meta.priority[gte:number]=1 # Filter by bounded range /images/v2?meta.priority[gte:number]=1&meta.priority[lte:number]=5 # Filter by nested metadata /images/v2?meta.region.name[eq]=eu-west # Combine metadata filters with creator /images/v2?meta.status[eq]=active&creator=user123 # Multiple metadata filters (AND logic) /images/v2?meta.status[eq]=active&meta.priority[eq:number]=5 ```
GET /accounts/{account_id}/images/v2 - Read
List image metadata keys
Lists filterable metadata keys used by images for an account.
GET /accounts/{account_id}/images/v2/metadata/keys - Write
Upload an image
Upload an image to CF Images. Images up to 10 Megabytes can be uploaded using a single HTTP POST (multipart/form-data) request by sending an image file or passing a URL accessible to the API.
POST /accounts/{account_id}/images/v1 - Write
Create authenticated direct upload URL V1 (deprecated)
Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a one-time upload URL. Use the V2 endpoint for additional features such as custom IDs and metadata.
POST /accounts/{account_id}/images/v1/direct_upload - Write
Create authenticated direct upload URL V2
Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.
POST /accounts/{account_id}/images/v2/direct_upload - Destructive
Delete image
Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache.
DELETE /accounts/{account_id}/images/v1/{image_id} - Destructive
Update image
Update a CF Images image's metadata, creator, or access control. On access control change, all copies of the image are purged from cache.
PATCH /accounts/{account_id}/images/v1/{image_id}
Cloudflare Images Keys
- Read
List Signing Keys
List your CF Images signing keys.
GET /accounts/{account_id}/images/v1/keys - Destructive
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.
DELETE /accounts/{account_id}/images/v1/keys/{signing_key_name} - Destructive
Create a new Signing Key
Create a new CF Images signing key with specified name. Returns all keys available.
PUT /accounts/{account_id}/images/v1/keys/{signing_key_name}
Cloudflare Images Variants
- Read
List variants
List existing CF Images variants.
GET /accounts/{account_id}/images/v1/variants - Read
Variant details
Fetch details for a CF Images variant.
GET /accounts/{account_id}/images/v1/variants/{variant_id} - Read
Variant details (flat) (deprecated)
Fetch details for a single variant with properties at the top level of the result.
GET /accounts/{account_id}/images/v1/variants/{variant_id}/flat - Write
Create a variant
Create a CF Images variant that allows you to resize images for different use cases.
POST /accounts/{account_id}/images/v1/variants - Destructive
Delete a variant
Delete a CF Images variant. This will purge the cache for all images associated with the variant.
DELETE /accounts/{account_id}/images/v1/variants/{variant_id} - Destructive
Update a variant
Update a CF Images variant. This will purge the cache for all images associated with the variant.
PATCH /accounts/{account_id}/images/v1/variants/{variant_id}
Cloudflare Images Sourcing Kit
- Read
List sourcing kit migrations
List CF Images imports.
GET /accounts/{account_id}/images/v2/sourcingkit/migrations - Read
Get sourcing kit migration
Get the configuration and status of a CF Images import.
GET /accounts/{account_id}/images/v2/sourcingkit/migrations/{migration_id} - Read
Get migration progress
Get progress and object counts for a CF Images import.
GET /accounts/{account_id}/images/v2/sourcingkit/migrations/{migration_id}/lifecycle - Read
List migration logs
List log entries for a CF Images import.
GET /accounts/{account_id}/images/v2/sourcingkit/migrations/{migration_id}/logs - Read
List sourcing kit sources
List sources configured for CF Images imports.
GET /accounts/{account_id}/images/v2/sourcingkit/sources - Read
Precheck source connectivity
Check S3 credentials without saving a source.
POST /accounts/{account_id}/images/v2/sourcingkit/sources/connectivity-precheck - Read
Get sourcing kit source
Get details of a source configured for CF Images imports.
GET /accounts/{account_id}/images/v2/sourcingkit/sources/{source_id} - Read
Get source connectivity status
Check whether a source can still access its S3 bucket.
GET /accounts/{account_id}/images/v2/sourcingkit/sources/{source_id}/connectivity - Write
Create a sourcing kit migration
Create a pending CF Images import from a configured source.
POST /accounts/{account_id}/images/v2/sourcingkit/migrations - Write
Abort a migration
Abort a running CF Images import. Already imported images will remain.
PATCH /accounts/{account_id}/images/v2/sourcingkit/migrations/{migration_id}/lifecycle/abort - Write
Start a migration
Start a pending CF Images import.
PATCH /accounts/{account_id}/images/v2/sourcingkit/migrations/{migration_id}/lifecycle/start - Write
Create a sourcing kit source
Configure an S3 source for CF Images imports.
POST /accounts/{account_id}/images/v2/sourcingkit/sources - Write
Update a sourcing kit source
Rename a source configured for CF Images imports.
PATCH /accounts/{account_id}/images/v2/sourcingkit/sources/{source_id} - Destructive
Delete a sourcing kit migration
Delete a completed, failed, or aborted CF Images import.
DELETE /accounts/{account_id}/images/v2/sourcingkit/migrations/{migration_id} - Destructive
Delete a sourcing kit source
Delete a source configured for CF Images imports. Sources used by active imports cannot be deleted.
DELETE /accounts/{account_id}/images/v2/sourcingkit/sources/{source_id}
Infrastructure Access Targets
- Read
List all targets
Lists and sorts an account's targets. Filters are optional and are ANDed together.
GET /accounts/{account_id}/infrastructure/targets - Read
Get target
Fetches a single infrastructure access target by its ID.
GET /accounts/{account_id}/infrastructure/targets/{target_id} - Write
Create new target
Creates a new infrastructure access target in the account.
POST /accounts/{account_id}/infrastructure/targets - Destructive
Delete targets (Deprecated) (deprecated)
Removes one or more targets.
DELETE /accounts/{account_id}/infrastructure/targets/batch - Destructive
Create new targets
Adds one or more targets.
PUT /accounts/{account_id}/infrastructure/targets/batch - Destructive
Delete targets
Removes one or more targets.
POST /accounts/{account_id}/infrastructure/targets/batch_delete - Destructive
Replace tags on existing targets
Replaces tags for one or more existing infrastructure access targets.
POST /accounts/{account_id}/infrastructure/targets/batch_tags - Destructive
Delete target
Removes a single infrastructure access target by its ID.
DELETE /accounts/{account_id}/infrastructure/targets/{target_id} - Destructive
Update target
Updates an existing infrastructure access target by its ID.
PUT /accounts/{account_id}/infrastructure/targets/{target_id}
ASN Intelligence
- Read
Get ASN Overview.
Gets an overview of the Autonomous System Number (ASN) and a list of subnets for it.
GET /accounts/{account_id}/intel/asn/{asn} - Read
Get ASN Subnets
Get ASN Subnets.
GET /accounts/{account_id}/intel/asn/{asn}/subnets
Security Center Insights
- Read
Retrieves Security Center Issues Types
Lists all available issue types in Security Center, describing categories of security issues.
GET /accounts/{account_id}/intel/attack-surface-report/issue-types - Read
Retrieves Security Center Issues (deprecated)
Lists all Security Center issues for the account, showing active security problems requiring attention.
GET /accounts/{account_id}/intel/attack-surface-report/issues - Read
Retrieves Security Center Issue Counts by Class (deprecated)
Retrieves Security Center issue counts aggregated by classification class.
GET /accounts/{account_id}/intel/attack-surface-report/issues/class - Read
Retrieves Security Center Issue Counts by Severity (deprecated)
Retrieves Security Center issue counts aggregated by severity level.
GET /accounts/{account_id}/intel/attack-surface-report/issues/severity - Read
Retrieves Security Center Issue Counts by Type (deprecated)
Retrieves Security Center issue counts aggregated by issue type.
GET /accounts/{account_id}/intel/attack-surface-report/issues/type - Read
Retrieves Security Center Insights
Lists all Security Center insights for the account, showing security findings and recommendations.
GET /accounts/{account_id}/security-center/insights - Read
Retrieves Security Center Insight Counts by Class
Retrieves Security Center insight counts aggregated by classification class.
GET /accounts/{account_id}/security-center/insights/class - Read
Retrieves a Partner Security Center Insight Count
Retrieves the uncapped count of active, non-dismissed, unclassified RiskRecon insights for the account.
GET /accounts/{account_id}/security-center/insights/partner-count - Read
Retrieves Security Center Insight Counts by Severity
Retrieves Security Center insight counts aggregated by severity level (critical, high, medium, low).
GET /accounts/{account_id}/security-center/insights/severity - Read
Retrieves Security Center Insight Counts by Type
Retrieves Security Center insight counts aggregated by insight type.
GET /accounts/{account_id}/security-center/insights/type - Read
Retrieves 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.
GET /accounts/{account_id}/security-center/insights/{issue_id}/context - Read
Retrieves 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.
GET /accounts/{account_id}/security-center/state - Read
Retrieves Zone Security Center Insights
Lists Security Center insights for a specific zone, showing zone-level security findings.
GET /zones/{zone_id}/security-center/insights - Read
Retrieves Zone Security Center Insight Counts by Class
Retrieves zone-specific Security Center insight counts aggregated by classification class.
GET /zones/{zone_id}/security-center/insights/class - Read
Retrieves a Partner Zone Security Center Insight Count
Retrieves the uncapped count of active, non-dismissed, unclassified RiskRecon insights for the zone.
GET /zones/{zone_id}/security-center/insights/partner-count - Read
Retrieves Zone Security Center Insight Counts by Severity
Retrieves zone-specific Security Center insight counts aggregated by severity level.
GET /zones/{zone_id}/security-center/insights/severity - Read
Retrieves Zone Security Center Insight Counts by Type
Retrieves zone-specific Security Center insight counts aggregated by insight type.
GET /zones/{zone_id}/security-center/insights/type - Write
Updates 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.
PATCH /accounts/{account_id}/security-center/insights/{issue_id}/classification - Write
Updates 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.
PATCH /zones/{zone_id}/security-center/insights/{issue_id}/classification - Destructive
Archives Security Center Insight (deprecated)
Deprecated endpoint for archiving Security Center insights. Use the newer archive-security-center-insight endpoint instead.
PUT /accounts/{account_id}/intel/attack-surface-report/issues/{issue_id}/dismiss - Destructive
Archives Security Center Insight
Archives a Security Center insight for an account, removing it from the active insights list while preserving historical data.
PUT /accounts/{account_id}/security-center/insights/{issue_id}/dismiss - Destructive
Updates 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.
PUT /accounts/{account_id}/security-center/state - Destructive
Archives Zone Security Center Insight
Archives a zone-specific Security Center insight, removing it from the active zone insights while preserving historical data.
PUT /zones/{zone_id}/security-center/insights/{issue_id}/dismiss
Passive DNS by IP
- Read
Get Passive DNS by IP
Gets a list of all the domains that have resolved to a specific IP address.
GET /accounts/{account_id}/intel/dns
Domain Intelligence
- Read
Get Domain Details
Gets security details and statistics about a domain.
GET /accounts/{account_id}/intel/domain - Read
Get Multiple Domain Details
Returns security details and statistics about multiple domains in a single request. **Behavior change — domain ranking is becoming opt-in.** This endpoint previously included domain ranking data in every response and accepted a `skip_ranking=true` query parameter to opt out. That parameter is being deprecated and ranking will no longer be returned by default. Callers that want ranking data must pass `include_ranking=true`. The `skip_ranking` parameter will be silently ignored once the change ships.
GET /accounts/{account_id}/intel/domain/bulk
Domain History
- Read
Get Domain History
Gets historical security threat and content categories currently and previously assigned to a domain.
GET /accounts/{account_id}/intel/domain-history
Custom Indicator Feeds
- Read
Get indicator feeds owned by this account
Retrieves details for all accessible custom threat indicator feeds.
GET /accounts/{account_id}/intel/indicator-feeds - Read
List indicator feed permissions
Lists current access permissions for custom threat indicator feeds.
GET /accounts/{account_id}/intel/indicator-feeds/permissions/view - Read
Get indicator feed metadata
Retrieves details for a specific custom threat indicator feed.
GET /accounts/{account_id}/intel/indicator-feeds/{feed_id} - Read
Get indicator feed data
Retrieves the raw data entries in a custom threat indicator feed.
GET /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data - Read
Download indicator feed data
Downloads the content of a custom threat indicator feed.
GET /accounts/{account_id}/intel/indicator-feeds/{feed_id}/download - Read
Get indicator feed 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.
GET /accounts/{account_id}/intel/indicator-feeds/{feed_id}/uploads/{upload_id} - Write
Create new indicator feed
Creates a new custom threat indicator feed for sharing threat intelligence data.
POST /accounts/{account_id}/intel/indicator-feeds - Destructive
Grant permission to indicator feed
Grants access permissions for a custom threat indicator feed to other accounts.
PUT /accounts/{account_id}/intel/indicator-feeds/permissions/add - Destructive
Create indicator feed provider
Creates a new indicator feed provider for an account. Only available to Intel accounts.
PUT /accounts/{account_id}/intel/indicator-feeds/permissions/createProvider - Destructive
Revoke permission to indicator feed
Revokes access permissions for a custom threat indicator feed.
PUT /accounts/{account_id}/intel/indicator-feeds/permissions/remove - Destructive
Update indicator feed metadata
Revises details for a specific custom threat indicator feed.
PUT /accounts/{account_id}/intel/indicator-feeds/{feed_id} - Destructive
Update indicator feed data
Revises the raw data entries in a custom threat indicator feed. Accepts both plain and gzipped STIX2/CRDF bodies. Gzip is detected by RFC 1952 magic bytes (`0x1f 0x8b`) and/or a `.gz` filename suffix (case-insensitive) — either signal alone is sufficient to trigger the gzip path; if the body is not valid gzip, the upload fails fast. Customers are encouraged to gzip larger uploads — the api-gateway 500 MB body cap applies to the on-the-wire (compressed) size, so gzip lets a single upload carry several GiB of decompressed STIX.
PUT /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot
IP Intelligence
- Read
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`.
GET /accounts/{account_id}/intel/ip
IP List
- Read
Get Available 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.
GET /accounts/{account_id}/intel/ip-lists
Miscategorization
- Write
Create Miscategorization
Allows you to submit requests to change a domain’s category. Requests that include category `169` (New Domains) or category `177` (Newly Seen) in any of `content_adds`, `content_removes`, `security_adds`, or `security_removes` will be rejected with a `400 Bad Request`. These categories are automatically managed and fall off 30 days after they are applied.
POST /accounts/{account_id}/intel/miscategorization
Sinkhole Config
- Read
List sinkholes owned by this account
Lists sinkholes owned by the account for redirecting malicious traffic.
GET /accounts/{account_id}/intel/sinkholes - Read
Get a sinkhole
Get the specified sinkhole by its unique identifier.
GET /accounts/{account_id}/intel/sinkholes/{sinkhole_id} - Read
List ingresses for a sinkhole
Returns all ingress rules associated with the specified sinkhole.
GET /accounts/{account_id}/intel/sinkholes/{sinkhole_id}/ingresses - Read
Get an ingress rule
Get the specified ingress rule associated with a sinkhole. The sinkhole must belong to the same account as the zone.
GET /zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id} - Write
Create a new sinkhole for your account
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.
POST /accounts/{account_id}/intel/sinkholes - Write
Create an ingress rule
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.
POST /zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses - Destructive
Delete a 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.
DELETE /accounts/{account_id}/intel/sinkholes/{sinkhole_id} - Destructive
Update a 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.
PUT /accounts/{account_id}/intel/sinkholes/{sinkhole_id} - Destructive
Delete an ingress rule
Delete the specified ingress rule. The sinkhole must belong to the same account as the zone.
DELETE /zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id} - Destructive
Update an ingress rule
Replaces the specified ingress rule. The sinkhole must belong to the same account as the zone.
PUT /zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
URL Intelligence
- Read
Get URL Intelligence
Gets security information about a URL, including content categories and risk types. The URL must be provided as a query parameter.
GET /accounts/{account_id}/intel/url
WHOIS Record
- Read
Get WHOIS Record
Retrieves WHOIS registration data for a domain, including registrant and nameserver information.
GET /accounts/{account_id}/intel/whois
Workers k2 other
- Read
List K2 streams
List or filter K2 streams in an account.
GET /accounts/{account_id}/k2/streams - Read
Get K2 stream
Get K2 stream details.
GET /accounts/{account_id}/k2/streams/{stream_id} - Read
List subscriptions with consumer lag
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.
GET /accounts/{account_id}/k2/streams/{stream_id}/subscriptions - Read
List subscriptions
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. List the subscriptions on the stream, oldest first. Requires an API token with K2 consume permission. To also see each subscription's consumer lag, use List subscriptions with consumer lag.
GET /subscriptions - Read
Get subscription
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Get a subscription. Requires an API token with K2 consume permission.
GET /subscriptions/{subscription_id} - Write
Create K2 stream
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.
POST /accounts/{account_id}/k2/streams - Write
Update K2 stream
Update a K2 stream. Omitted `http` settings, such as `authentication` and `cors`, keep their current values. Disabling HTTP keeps them, so enabling HTTP again restores them. At least one input must remain enabled.
PATCH /accounts/{account_id}/k2/streams/{stream_id} - Write
Produce records
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Appends a batch of records to the stream. The batch is written atomically, so either every record is stored or none are. Requests are limited to 5 MB, compressed and decompressed, and each record to 1 MB. Gzip bodies are accepted when `Content-Encoding` is `gzip`. Requires an API token with K2 produce permission unless the stream's HTTP input sets `authentication` to false. Errors use a `success` and `error` body instead of the `errors` array.
POST /produce - Write
Create subscription
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Create a subscription, which reads the stream from its own position. Creating a subscription with an existing name returns the existing subscription. A stream can have up to 100 subscriptions. Requires an API token with K2 consume permission.
POST /subscriptions - Write
Acknowledge batch
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Confirm that the worker processed a batch, so K2 does not deliver it again. Acknowledging an unknown, already acknowledged, or reassigned batch also succeeds. Requires an API token with K2 consume permission.
POST /subscriptions/{subscription_id}/batches/{batch_id}/ack - Write
Extend batch lease
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Extend the lease on a batch the worker still holds to 5 minutes from now. Returns 409 with code 10218 when the worker no longer holds the lease; stop processing the batch and call Consume again. Requires an API token with K2 consume permission.
POST /subscriptions/{subscription_id}/batches/{batch_id}/extend - Write
Release batch
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Returns a batch to the subscription for redelivery. The next Consume request from any worker receives them under a new `batch_id`. Releasing an unknown or already settled batch also succeeds. Requires an API token with K2 consume permission.
POST /subscriptions/{subscription_id}/batches/{batch_id}/nack - Write
Consume records
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Returns the next batch of records and leases it to the worker for 5 minutes. ACK the batch after processing it, NACK it to have it redelivered, or extend the lease if processing takes longer. When no records are available, the response has no records and a null `batch_id`. Returns 429 with code 10216 when every parallel read slot for the subscription is leased, and 409 with code 10217 while this worker has a read in progress; retry both. Requires an API token with K2 consume permission.
POST /subscriptions/{subscription_id}/consume - Destructive
Delete K2 stream
Delete a K2 stream in an account. Deleting a stream that does not exist also succeeds.
DELETE /accounts/{account_id}/k2/streams/{stream_id} - Destructive
Delete subscription
Send to the stream's `endpoint`, `https://<stream_id>.k2.cloudflarestorage.com`. Delete a subscription and its position in the stream. Requires an API token with K2 consume permission.
DELETE /subscriptions/{subscription_id}
Account Load Balancers
- Read
List Account Load Balancers
List configured account-scoped load balancers.
GET /accounts/{account_id}/load_balancers - Read
List Load Balancer Usage
Get current load balancer resource usage counts for an account.
GET /accounts/{account_id}/load_balancers/usage - Read
Account Load Balancer Details
Fetch a single configured account-scoped load balancer.
GET /accounts/{account_id}/load_balancers/{load_balancer_id} - Write
Create Account Load Balancer
Create a new account-scoped load balancer.
POST /accounts/{account_id}/load_balancers - Destructive
Delete Account Load Balancer
Delete a configured account-scoped load balancer.
DELETE /accounts/{account_id}/load_balancers/{load_balancer_id} - Destructive
Patch Account Load Balancer
Apply changes to an existing account-scoped load balancer, overwriting the supplied properties.
PATCH /accounts/{account_id}/load_balancers/{load_balancer_id} - Destructive
Update Account Load Balancer
Update a configured account-scoped load balancer.
PUT /accounts/{account_id}/load_balancers/{load_balancer_id}
Account Load Balancer Monitor Groups
- Read
List Monitor Groups
List configured monitor groups.
GET /accounts/{account_id}/load_balancers/monitor_groups - Read
Monitor Group Details
Fetch a single configured monitor group.
GET /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id} - Read
List Monitor Group References
Get the list of resources that reference the provided monitor group.
GET /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}/references - Write
Create Monitor Group
Create a new monitor group.
POST /accounts/{account_id}/load_balancers/monitor_groups - Write
Patch Monitor Group
Apply changes to an existing monitor group, overwriting the supplied properties.
PATCH /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id} - Destructive
Delete Monitor Group
Delete a configured monitor group.
DELETE /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id} - Destructive
Update Monitor Group
Modify a configured monitor group.
PUT /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}
Account Load Balancer Monitors
- Read
List Monitors
List configured monitors for an account.
GET /accounts/{account_id}/load_balancers/monitors - Read
Monitor Details
Fetch a single configured monitor for an account.
GET /accounts/{account_id}/load_balancers/monitors/{monitor_id} - Read
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.
POST /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview - Read
List Monitor References
Get the list of resources that reference the provided monitor.
GET /accounts/{account_id}/load_balancers/monitors/{monitor_id}/references - Read
Preview Result
Get the result of a previous preview operation using the provided preview_id.
GET /accounts/{account_id}/load_balancers/preview/{preview_id} - Write
Create Monitor
Create a configured monitor.
POST /accounts/{account_id}/load_balancers/monitors - Write
Patch Monitor
Apply changes to an existing monitor, overwriting the supplied properties.
PATCH /accounts/{account_id}/load_balancers/monitors/{monitor_id} - Destructive
Delete Monitor
Delete a configured monitor.
DELETE /accounts/{account_id}/load_balancers/monitors/{monitor_id} - Destructive
Update Monitor
Modify a configured monitor.
PUT /accounts/{account_id}/load_balancers/monitors/{monitor_id}
Account Load Balancer Pools
- Read
List Pools
List configured pools.
GET /accounts/{account_id}/load_balancers/pools - Read
Pool Details
Fetch a single configured pool.
GET /accounts/{account_id}/load_balancers/pools/{pool_id} - Read
Pool Health Details
Fetch the latest pool health status for a single pool.
GET /accounts/{account_id}/load_balancers/pools/{pool_id}/health - Read
Preview Pool
Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
POST /accounts/{account_id}/load_balancers/pools/{pool_id}/preview - Read
List Pool References
Get the list of resources that reference the provided pool.
GET /accounts/{account_id}/load_balancers/pools/{pool_id}/references - Write
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`.
PATCH /accounts/{account_id}/load_balancers/pools - Write
Create Pool
Create a new pool.
POST /accounts/{account_id}/load_balancers/pools - Write
Patch Pool
Apply changes to an existing pool, overwriting the supplied properties.
PATCH /accounts/{account_id}/load_balancers/pools/{pool_id} - Destructive
Delete Pool
Delete a configured pool.
DELETE /accounts/{account_id}/load_balancers/pools/{pool_id} - Destructive
Update Pool
Modify a configured pool.
PUT /accounts/{account_id}/load_balancers/pools/{pool_id}
Load Balancer Regions
- Read
List Regions
List all region mappings.
GET /accounts/{account_id}/load_balancers/regions - Read
Get Region
Get a single region mapping.
GET /accounts/{account_id}/load_balancers/regions/{region_id} - Read
List Regions
List all region mappings in the user context.
GET /user/load_balancers/regions
Account Load Balancer Search
- Read
Search Resources
Search for Load Balancing resources.
GET /accounts/{account_id}/load_balancers/search
Logpush jobs for an account
- Read
List 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.
GET /accounts/{account_id}/logpush/datasets/{dataset_id}/fields - Read
List Logpush jobs for a dataset
Lists Logpush jobs for an account for a dataset.
GET /accounts/{account_id}/logpush/datasets/{dataset_id}/jobs - Read
List Logpush jobs
Lists Logpush jobs for an account.
GET /accounts/{account_id}/logpush/jobs - Read
Get Logpush job details
Gets the details of a Logpush job.
GET /accounts/{account_id}/logpush/jobs/{job_id} - Read
Get ownership challenge
Gets a new ownership challenge sent to your destination.
POST /accounts/{account_id}/logpush/ownership - Read
Validate ownership challenge
Validates ownership challenge of the destination.
POST /accounts/{account_id}/logpush/ownership/validate - Read
Validate destination
Validates destination.
POST /accounts/{account_id}/logpush/validate/destination - Read
Check destination exists
Checks if there is an existing job with a destination.
POST /accounts/{account_id}/logpush/validate/destination/exists - Read
Validate origin
Validates logpull origin with logpull_options.
POST /accounts/{account_id}/logpush/validate/origin - Write
Create Logpush job
Creates a new Logpush job for an account.
POST /accounts/{account_id}/logpush/jobs - Destructive
Delete Logpush job
Deletes a Logpush job.
DELETE /accounts/{account_id}/logpush/jobs/{job_id} - Destructive
Update Logpush job
Updates a Logpush job.
PUT /accounts/{account_id}/logpush/jobs/{job_id}
Logpush transformers
- Read
List transformers
Lists all custom log transformers for an account.
GET /accounts/{account_id}/logpush/transformers - Read
Preview transformer
Executes a SQL transformer against a single input record and returns the transformed output. This is a stateless endpoint — nothing is persisted.
POST /accounts/{account_id}/logpush/transformers/preview - Read
Get transformer
Gets a single custom log transformer by ID.
GET /accounts/{account_id}/logpush/transformers/{transformer_id} - Read
Get transformer content
Returns the SQL query content for a transformer. Without query params, returns the latest version. With `version_id`, returns the specified version.
GET /accounts/{account_id}/logpush/transformers/{transformer_id}/content - Read
List transformer versions
Returns version metadata for a transformer, newest first. Each version corresponds to a SQL query update.
GET /accounts/{account_id}/logpush/transformers/{transformer_id}/versions - Write
Create transformer
Creates a new custom log transformer for an account.
POST /accounts/{account_id}/logpush/transformers - Destructive
Delete transformer
Deletes a custom log transformer. Returns 409 Conflict if any active logpush jobs reference the transformer.
DELETE /accounts/{account_id}/logpush/transformers/{transformer_id} - Destructive
Update transformer
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.
PUT /accounts/{account_id}/logpush/transformers/{transformer_id}
Logcontrol CMB config for an account
- Read
Get CMB config
Gets CMB config.
GET /accounts/{account_id}/logs/control/cmb/config - Write
Update CMB config
Updates CMB config.
POST /accounts/{account_id}/logs/control/cmb/config - Destructive
Delete CMB config
Deletes CMB config.
DELETE /accounts/{account_id}/logs/control/cmb/config
Log Explorer Datasets
- Read
List account datasets
Returns all Log Explorer datasets configured for the account. Pass `include_zones=true` to also include zone-level datasets that belong to this account. List responses omit the `fields` property; use the single-dataset endpoint to retrieve field configuration.
GET /accounts/{account_id}/logs/explorer/datasets - Read
List available account datasets
Returns all dataset types that this account can create. Each entry includes the dataset schema and timestamp field. The schema shows all possible fields for a dataset. However, not all fields may be available for your account. When creating or updating a dataset, only fields available to your account can be enabled. If you request a field that is not available, you will receive an error.
GET /accounts/{account_id}/logs/explorer/datasets/available - Read
Get an account dataset
Retrieve a single Log Explorer dataset by ID for the account.
GET /accounts/{account_id}/logs/explorer/datasets/{dataset_id} - Read
List zone datasets
Returns all Log Explorer datasets configured for the zone. List responses omit the `fields` property; use the single-dataset endpoint to retrieve field configuration.
GET /zones/{zone_id}/logs/explorer/datasets - Read
List available zone datasets
Returns all dataset types that this zone can create. Each entry includes the dataset schema and timestamp field. The schema shows all possible fields for a dataset. However, not all fields may be available for your account. When creating or updating a dataset, only fields available to your account can be enabled. If you request a field that is not available, you will receive an error.
GET /zones/{zone_id}/logs/explorer/datasets/available - Read
Get a zone dataset
Retrieve a single Log Explorer dataset by ID for the zone.
GET /zones/{zone_id}/logs/explorer/datasets/{dataset_id} - Write
Create an account dataset
Create a new Log Explorer dataset for the account. List available account datasets to see the dataset types and fields you can use. The `fields` property is optional. If not specified, all available fields will be enabled. For dataset field definitions, see: https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/
POST /accounts/{account_id}/logs/explorer/datasets - Write
Create a zone dataset
Create a new Log Explorer dataset for the zone. List available zone datasets to see the dataset types and fields you can use. The `fields` property is optional. If not specified, all available fields will be enabled. For dataset field definitions, see: https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/
POST /zones/{zone_id}/logs/explorer/datasets - Destructive
Delete an account dataset
Deletes a Log Explorer dataset for the account. Dataset deletion must not be protected.
DELETE /accounts/{account_id}/logs/explorer/datasets/{dataset_id} - Destructive
Update an account dataset
Updates the enabled state and/or field configuration of an account dataset.
PUT /accounts/{account_id}/logs/explorer/datasets/{dataset_id} - Destructive
Delete a zone dataset
Deletes a Log Explorer dataset for the zone. Dataset deletion must not be protected.
DELETE /zones/{zone_id}/logs/explorer/datasets/{dataset_id} - Destructive
Update a zone dataset
Updates the enabled state and/or field configuration of a zone dataset.
PUT /zones/{zone_id}/logs/explorer/datasets/{dataset_id}
Log Explorer Queries
- Read
Run a log query (deprecated)
Run a SQL query against account-level datasets. The SQL query is passed as the `query` query parameter. Because the query appears in the URL, it is subject to gateway and proxy URL-length limits and may be recorded in access logs. This endpoint is deprecated in favour of the POST variant which sends the query in the request body.
GET /accounts/{account_id}/logs/explorer/query/sql - Read
Run a log query (deprecated)
Run a SQL query against zone-level datasets. The SQL query is passed as the `query` query parameter. Because the query appears in the URL, it is subject to gateway and proxy URL-length limits and may be recorded in access logs. This endpoint is deprecated in favour of the POST variant which sends the query in the request body.
GET /zones/{zone_id}/logs/explorer/query/sql - Write
Run a log query
Run a SQL query against account-level datasets. Timestamp fields are RFC3339 strings. Filter with: WHERE {timestamp_field} >= now() - INTERVAL '30' DAY WHERE {timestamp_field} >= '2026-04-01T00:00:00Z' WHERE {timestamp_field} BETWEEN '2026-04-01T00:00:00Z' AND '2026-04-30T23:59:59Z' List configured account datasets to see enabled account-level datasets. Zone-level datasets will not appear here. List available account datasets to inspect their schemas and timestamp fields. For more information about the datasets, and the meaning of each field, check out https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/
POST /accounts/{account_id}/logs/explorer/query/sql - Write
Run a log query
Run a SQL query against zone-level datasets. Timestamp fields are RFC3339 strings. Filter with: WHERE {timestamp_field} >= now() - INTERVAL '30' DAY WHERE {timestamp_field} >= '2026-04-01T00:00:00Z' WHERE {timestamp_field} BETWEEN '2026-04-01T00:00:00Z' AND '2026-04-30T23:59:59Z' List configured zone datasets to see enabled zone-level datasets. List available zone datasets to inspect their schemas and timestamp fields. For more information about the datasets, and the meaning of each field, check out https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/
POST /zones/{zone_id}/logs/explorer/query/sql
Logpull
- Read
List log files
Lists R2 objects containing logs matching the provided query parameters.
GET /accounts/{account_id}/logs/list - Read
Retrieve logs
Returns logs stored in R2 that match the provided query parameters.
GET /accounts/{account_id}/logs/retrieve
Dos flowtrackd api other
- Read
List all DNS Protection rules.
List all DNS Protection rules for an account.
GET /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules - Read
Get DNS Protection rule.
Get a DNS Protection rule specified by the given UUID.
GET /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules/{rule_id} - Read
List all allowlist prefixes.
List all allowlist prefixes for an account.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist - Read
Get allowlist prefix.
Get an allowlist prefix specified by the given UUID.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id} - Read
List all prefixes.
List all prefixes for an account.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes - Read
Get prefix.
Get a prefix specified by the given UUID.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id} - Read
List all SYN Protection filters.
List all SYN Protection filters for an account.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters - Read
Get SYN Protection filter.
Get a SYN Protection filter specified by the given UUID.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id} - Read
List all SYN Protection rules.
List all SYN Protection rules for an account.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules - Read
Get SYN Protection rule.
Get a SYN Protection rule specified by the given UUID.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id} - Read
List all TCP Flow Protection filters.
List all TCP Flow Protection filters for an account.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters - Read
Get TCP Flow Protection filter.
Get a TCP Flow Protection filter specified by the given UUID.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id} - Read
List all TCP Flow Protection rules.
List all TCP Flow Protection rules for an account.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules - Read
Get TCP Flow Protection rule.
Get a TCP Flow Protection rule specified by the given UUID.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id} - Read
Get protection status.
Get the protection status of the account.
GET /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status - Write
Create DNS Protection rule.
Create a DNS Protection rule for an account.
POST /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules - Write
Update DNS Protection rule.
Update a DNS Protection rule specified by the given UUID.
PATCH /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules/{rule_id} - Write
Create allowlist prefix.
Create an allowlist prefix for an account.
POST /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist - Write
Update allowlist prefix.
Update an allowlist prefix specified by the given UUID.
PATCH /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id} - Write
Create prefix.
Create a prefix for an account.
POST /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes - Write
Create multiple prefixes.
Create multiple prefixes for an account.
POST /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/bulk - Write
Update prefix.
Update a prefix specified by the given UUID.
PATCH /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id} - Write
Create a SYN Protection filter.
Create a SYN Protection filter for an account.
POST /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters - Write
Update SYN Protection filter.
Update a SYN Protection filter specified by the given UUID.
PATCH /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id} - Write
Create SYN Protection rule.
Create a SYN Protection rule for an account.
POST /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules - Write
Update SYN Protection rule.
Update a SYN Protection rule specified by the given UUID.
PATCH /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id} - Write
Create a TCP Flow Protection filter.
Create a TCP Flow Protection filter for an account.
POST /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters - Write
Update TCP Flow Protection filter.
Update a TCP Flow Protection filter specified by the given UUID.
PATCH /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id} - Write
Create TCP Flow Protection rule.
Create a TCP Flow Protection rule for an account.
POST /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules - Write
Update TCP Flow Protection rule.
Update a TCP Flow Protection rule specified by the given UUID.
PATCH /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id} - Write
Update protection status.
Update the protection status of the account.
PATCH /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status - Destructive
Delete all DNS Protection rules.
Delete all DNS Protection rules for an account.
DELETE /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules - Destructive
Delete DNS Protection rule.
Delete a DNS Protection rule specified by the given UUID.
DELETE /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules/{rule_id} - Destructive
Delete all allowlist prefixes.
Delete all allowlist prefixes for an account.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist - Destructive
Delete allowlist prefix.
Delete the allowlist prefix for an account given a UUID.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id} - Destructive
Delete all prefixes.
Delete all prefixes for an account.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes - Destructive
Delete prefix.
Delete the prefix for an account given a UUID.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id} - Destructive
Delete all SYN Protection filters.
Delete all SYN Protection filters for an account.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters - Destructive
Delete SYN Protection filter.
Delete a SYN Protection filter specified by the given UUID.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id} - Destructive
Delete all SYN Protection rules.
Delete all SYN Protection rules for an account.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules - Destructive
Delete SYN Protection rule.
Delete a SYN Protection rule specified by the given UUID.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id} - Destructive
Delete all TCP Flow Protection filters.
Delete all TCP Flow Protection filters for an account.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters - Destructive
Delete TCP Flow Protection filter.
Delete a TCP Flow Protection filter specified by the given UUID.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id} - Destructive
Delete all TCP Flow Protection rules.
Delete all TCP Flow Protection rules for an account.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules - Destructive
Delete TCP Flow Protection rule.
Delete a TCP Flow Protection rule specified by the given UUID.
DELETE /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id}
Magic Account Apps
- Read
List Apps
Lists Apps associated with an account.
GET /accounts/{account_id}/magic/apps - Write
Create a new App
Creates a new App for an account
POST /accounts/{account_id}/magic/apps - Write
Update an App
Updates an Account App
PATCH /accounts/{account_id}/magic/apps/{account_app_id} - Destructive
Delete Account App
Deletes specific Account App.
DELETE /accounts/{account_id}/magic/apps/{account_app_id} - Destructive
Update an App
Updates an Account App
PUT /accounts/{account_id}/magic/apps/{account_app_id}
Magic BGP Filter Profiles
- Read
List BGP Filter Profiles
Lists all BGP filter profiles for an account.
GET /accounts/{account_id}/magic/bgp/filter_profiles - Read
Get BGP Filter Profile
Gets a specific BGP filter profile for an account.
GET /accounts/{account_id}/magic/bgp/filter_profiles/{profile_id} - Write
Create BGP Filter Profile
Creates a new BGP filter profile for an account.
POST /accounts/{account_id}/magic/bgp/filter_profiles - Destructive
Delete BGP Filter Profile
Deletes a BGP filter profile.
DELETE /accounts/{account_id}/magic/bgp/filter_profiles/{profile_id} - Destructive
Update BGP Filter Profile
Updates a BGP filter profile. Omitted properties are left unchanged. To clear an existing description send `description: ""`.
PUT /accounts/{account_id}/magic/bgp/filter_profiles/{profile_id}
Magic BGP Settings
- Read
Get BGP Settings
Gets the BGP settings for an account, including the default ASN and redistribution configuration.
GET /accounts/{account_id}/magic/bgp/settings - Destructive
Update BGP Settings
Modifies the BGP settings for an account, including the default ASN and redistribution configuration.
PUT /accounts/{account_id}/magic/bgp/settings
Magic CF1 Sites
- Read
List CF1 Sites
Lists CF1 Sites associated with an account. A CF1 Site represents a physical customer network location with optional geographic coordinates.
GET /accounts/{account_id}/magic/cf1_sites - Read
Get CF1 Site
Gets a specific CF1 Site for an account.
GET /accounts/{account_id}/magic/cf1_sites/{cf1_site_id} - Write
Create CF1 Sites
Creates new CF1 Sites for an account. Each site must have a unique name within the account.
POST /accounts/{account_id}/magic/cf1_sites - Write
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.
PATCH /accounts/{account_id}/magic/cf1_sites/{cf1_site_id} - Destructive
Delete CF1 Site
Deletes a specific CF1 Site for an account.
DELETE /accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Magic CF1 Site Ramps
- Read
List CF1 Site Ramps
Lists ramps (network connections) associated with a CF1 Site. Ramps represent GRE tunnels, IPsec tunnels, interconnects, or MCONN links.
GET /accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps - Read
Get CF1 Site Ramp
Gets a specific ramp for a CF1 Site.
GET /accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id} - Write
Create CF1 Site Ramps
Creates ramps (network connections) for a CF1 Site.
POST /accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps - Destructive
Delete CF1 Site Ramp
Deletes a specific ramp from a CF1 Site.
DELETE /accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
Magic Interconnects
- Read
List interconnects
Lists interconnects associated with an account.
GET /accounts/{account_id}/magic/cf_interconnects - Read
List interconnect Details
Lists details for a specific interconnect.
GET /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id} - Destructive
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.
PUT /accounts/{account_id}/magic/cf_interconnects - Destructive
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.
PUT /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}
Magic Connectors
- Read
List Connectors
Lists Magic WAN Connectors.
GET /accounts/{account_id}/magic/connectors - Read
Get Connector
Gets a Magic WAN Connector.
GET /accounts/{account_id}/magic/connectors/{connector_id} - Read
List Interrupts
Lists interrupts for a Magic WAN Connector.
GET /accounts/{account_id}/magic/connectors/{connector_id}/interrupts - Read
List Events
Lists Magic WAN Connector Telemetry Events
GET /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events - Read
Get latest Events
Gets latest Magic WAN Connector Telemetry Events
GET /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/latest - Read
Get Event
Gets Magic WAN Connector Telemetry Event
GET /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/{event_t}.{event_n} - Read
List Snapshots
Lists Magic WAN Connector Telemetry Snapshots
GET /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots - Read
Get latest Snapshots
Gets latest Magic WAN Connector Telemetry Snapshots
GET /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/latest - Read
Get Snapshot
Gets Magic WAN Connector Telemetry Snapshot
GET /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/{snapshot_t} - Write
Create Connector
Creates a Magic WAN Connector.
POST /accounts/{account_id}/magic/connectors - Write
Edit Connector
Edits properties of a Magic WAN Connector. May be used to re-provision a license key.
PATCH /accounts/{account_id}/magic/connectors/{connector_id} - Destructive
Delete Connector
Deletes a Magic WAN Connector.
DELETE /accounts/{account_id}/magic/connectors/{connector_id} - Destructive
Update Connector
Updates properties of a Magic WAN Connector. May be used to re-provision a license key.
PUT /accounts/{account_id}/magic/connectors/{connector_id} - Destructive
Create Interrupt
Creates an interrupt for a Magic WAN Connector.
POST /accounts/{account_id}/magic/connectors/{connector_id}/interrupts
Magic GRE tunnels
- Read
List GRE tunnels
Lists GRE tunnels associated with an account.
GET /accounts/{account_id}/magic/gre_tunnels - Read
List GRE Tunnel Details
Lists informtion for a specific GRE tunnel.
GET /accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id} - Write
Create a GRE tunnel
Creates a new GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
POST /accounts/{account_id}/magic/gre_tunnels - Destructive
Update multiple GRE tunnels
Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
PUT /accounts/{account_id}/magic/gre_tunnels - Destructive
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.
DELETE /accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id} - Destructive
Update GRE Tunnel
Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
PUT /accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}
Magic IPsec tunnels
- Read
List IPsec tunnels
Lists IPsec tunnels associated with an account.
GET /accounts/{account_id}/magic/ipsec_tunnels - Read
List IPsec tunnel details
Lists details for a specific IPsec tunnel.
GET /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id} - Write
Create an IPsec tunnel
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.
POST /accounts/{account_id}/magic/ipsec_tunnels - Destructive
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.
PUT /accounts/{account_id}/magic/ipsec_tunnels - Destructive
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.
DELETE /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id} - Destructive
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.
PUT /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}
Magic Redundancy Groups
- Read
List Redundancy Groups
Lists redundancy groups associated with an account, including full member tunnel data.
GET /accounts/{account_id}/magic/redundancy_groups - Read
Get Redundancy Group Details
Gets details for a specific redundancy group, including full member tunnel data.
GET /accounts/{account_id}/magic/redundancy_groups/{redundancy_group_id} - Write
Create a Redundancy Group
Creates a new redundancy group, optionally with tunnel members.
POST /accounts/{account_id}/magic/redundancy_groups - Destructive
Delete a Redundancy Group
Deletes a redundancy group. Member tunnels are not deleted — their redundancy_group_id is cleared.
DELETE /accounts/{account_id}/magic/redundancy_groups/{redundancy_group_id} - Destructive
Update a Redundancy Group
Replaces the name, description, and full set of members for an existing redundancy group.
PUT /accounts/{account_id}/magic/redundancy_groups/{redundancy_group_id}
Magic Static Routes
- Read
List Routes
List all Magic static routes.
GET /accounts/{account_id}/magic/routes - Read
Route Details
Get a specific Magic static route.
GET /accounts/{account_id}/magic/routes/{route_id} - Write
Create a Route
Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.
POST /accounts/{account_id}/magic/routes - Destructive
Delete Many Routes
Delete multiple Magic static routes.
DELETE /accounts/{account_id}/magic/routes - Destructive
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.
PUT /accounts/{account_id}/magic/routes - Destructive
Delete Route
Disable and remove a specific Magic static route.
DELETE /accounts/{account_id}/magic/routes/{route_id} - Destructive
Update Route
Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.
PUT /accounts/{account_id}/magic/routes/{route_id}
Magic Sites
- Read
List Sites
Lists Sites associated with an account. Use connectorid query param to return sites where connectorid matches either site.ConnectorID or site.SecondaryConnectorID.
GET /accounts/{account_id}/magic/sites - Read
Site Details
Get a specific Site.
GET /accounts/{account_id}/magic/sites/{site_id} - Write
Create a new Site
Creates a new Site
POST /accounts/{account_id}/magic/sites - Write
Patch Site
Patch a specific Site.
PATCH /accounts/{account_id}/magic/sites/{site_id} - Destructive
Delete Site
Remove a specific Site.
DELETE /accounts/{account_id}/magic/sites/{site_id} - Destructive
Update Site
Update a specific Site.
PUT /accounts/{account_id}/magic/sites/{site_id}
Magic Site ACLs
- Read
List Site ACLs
Lists Site ACLs associated with an account.
GET /accounts/{account_id}/magic/sites/{site_id}/acls - Read
Site ACL Details
Get a specific Site ACL.
GET /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id} - Write
Create a new Site ACL
Creates a new Site ACL.
POST /accounts/{account_id}/magic/sites/{site_id}/acls - Write
Patch Site ACL
Patch a specific Site ACL.
PATCH /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id} - Destructive
Delete Site ACL
Remove a specific Site ACL.
DELETE /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id} - Destructive
Update Site ACL
Update a specific Site ACL.
PUT /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}
Magic Site App Configs
- Read
List App Configs
Lists App Configs associated with a site.
GET /accounts/{account_id}/magic/sites/{site_id}/app_configs - Write
Create a new App Config
Creates a new App Config for a site
POST /accounts/{account_id}/magic/sites/{site_id}/app_configs - Write
Update an App Config
Updates an App Config for a site
PATCH /accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id} - Destructive
Delete App Config
Deletes specific App Config associated with a site.
DELETE /accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id} - Destructive
Update an App Config
Updates an App Config for a site
PUT /accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}
Magic Site LANs
- Read
List Site LANs
Lists Site LANs associated with an account.
GET /accounts/{account_id}/magic/sites/{site_id}/lans - Read
Site LAN Details
Get a specific Site LAN.
GET /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id} - Write
Create a new Site LAN
Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.
POST /accounts/{account_id}/magic/sites/{site_id}/lans - Write
Patch Site LAN
Patch a specific Site LAN.
PATCH /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id} - Destructive
Delete Site LAN
Remove a specific Site LAN.
DELETE /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id} - Destructive
Update Site LAN
Update a specific Site LAN.
PUT /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}
Magic Site Net Flow Config
- Read
NetFlow Configuration Details
Get NetFlow configuration for a site.
GET /accounts/{account_id}/magic/sites/{site_id}/netflow_config - Write
Update NetFlow Configuration
Updates NetFlow configuration for a site.
PATCH /accounts/{account_id}/magic/sites/{site_id}/netflow_config - Write
Create NetFlow Configuration
Creates a NetFlow configuration for a site.
POST /accounts/{account_id}/magic/sites/{site_id}/netflow_config - Destructive
Delete NetFlow Configuration
Remove NetFlow configuration for a site.
DELETE /accounts/{account_id}/magic/sites/{site_id}/netflow_config - Destructive
Update NetFlow Configuration
Updates NetFlow configuration for a site (partial update).
PUT /accounts/{account_id}/magic/sites/{site_id}/netflow_config
Magic Site WANs
- Read
List Site WANs
Lists Site WANs associated with an account.
GET /accounts/{account_id}/magic/sites/{site_id}/wans - Read
Site WAN Details
Get a specific Site WAN.
GET /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id} - Write
Create a new Site WAN
Creates a new Site WAN.
POST /accounts/{account_id}/magic/sites/{site_id}/wans - Write
Patch Site WAN
Patch a specific Site WAN.
PATCH /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id} - Destructive
Delete Site WAN
Remove a specific Site WAN.
DELETE /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id} - Destructive
Update Site WAN
Update a specific Site WAN.
PUT /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}
Vulnerability Discovery
- Read
List repositories
Lists repositories available for vulnerability discovery in an account.
GET /accounts/{account_id}/managed-defense/vulnerability-discovery/repos - Read
Get repository
Gets repository metadata, source readiness, and customer scan history.
GET /accounts/{account_id}/managed-defense/vulnerability-discovery/repos/{repo_id} - Read
Get reviewed vulnerability report
Gets the repository projection of the active operator-reviewed scan report. `scan_id` is the customer scan's stable request ID.
GET /accounts/{account_id}/managed-defense/vulnerability-discovery/repos/{repo_id}/scans/{scan_id}/report - Read
List scans
Lists customer-requested scans across review and execution lifecycle states.
GET /accounts/{account_id}/managed-defense/vulnerability-discovery/scans - Read
Get scan
Gets one customer-requested scan across its review and execution lifecycle.
GET /accounts/{account_id}/managed-defense/vulnerability-discovery/scans/{scan_id} - Read
Get reviewed vulnerability report
Gets the active operator-reviewed scan report. Repository metadata records report readiness even when no publication is available.
GET /accounts/{account_id}/managed-defense/vulnerability-discovery/scans/{scan_id}/report - Write
Create repository
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.
POST /accounts/{account_id}/managed-defense/vulnerability-discovery/repos - Write
Create upload token
Creates a one-hour write token for an existing upload repository. Worker-imported repositories are system-managed and cannot receive upload tokens.
POST /accounts/{account_id}/managed-defense/vulnerability-discovery/repos/{repo_id}/token - Write
Create scan
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.
POST /accounts/{account_id}/managed-defense/vulnerability-discovery/scans
Account Members
- Read
List Members
List all members of an account.
GET /accounts/{account_id}/members - Read
Member Details
Get information about a specific member of an account.
GET /accounts/{account_id}/members/{member_id} - Write
Add Member
Add a user to the list of members for this account.
POST /accounts/{account_id}/members - Destructive
Remove Member
Remove a member from an account.
DELETE /accounts/{account_id}/members/{member_id} - Destructive
Update Member
Modify an account member.
PUT /accounts/{account_id}/members/{member_id}
Magic Network Monitoring Configuration
- Read
List account configuration
Lists default sampling, router IPs and warp devices for account.
GET /accounts/{account_id}/mnm/config - Read
List rules and account configuration
Lists default sampling, router IPs, warp devices, and rules for account.
GET /accounts/{account_id}/mnm/config/full - Write
Update account configuration fields
Update fields in an existing network monitoring configuration.
PATCH /accounts/{account_id}/mnm/config - Write
Create account configuration
Create a new network monitoring configuration.
POST /accounts/{account_id}/mnm/config - Destructive
Delete account configuration
Delete an existing network monitoring configuration.
DELETE /accounts/{account_id}/mnm/config - Destructive
Update an entire account configuration
Update an existing network monitoring configuration, requires the entire configuration to be updated at once.
PUT /accounts/{account_id}/mnm/config
Magic Network Monitoring Rules
- Read
List rules
Lists network monitoring rules for account.
GET /accounts/{account_id}/mnm/rules - Read
Get rule
List a single network monitoring rule for account.
GET /accounts/{account_id}/mnm/rules/{rule_id} - Write
Create rules
Create network monitoring rules for account. Currently only supports creating a single rule per API request.
POST /accounts/{account_id}/mnm/rules - Write
Create rules in bulk
Create multiple network monitoring rules for account in a single request. Supports up to 100 rules per request. All rules in a single request must be of the same type.
POST /accounts/{account_id}/mnm/rules/bulk - Write
Update rule
Update a network monitoring rule for account.
PATCH /accounts/{account_id}/mnm/rules/{rule_id} - Write
Update advertisement for rule
Update advertisement for rule.
PATCH /accounts/{account_id}/mnm/rules/{rule_id}/advertisement - Destructive
Update rules
Update network monitoring rules for account.
PUT /accounts/{account_id}/mnm/rules - Destructive
Update rules in bulk
Update multiple network monitoring rules for account in a single request. Supports up to 100 rules per request. All rules in a single request must be of the same type.
PUT /accounts/{account_id}/mnm/rules/bulk - Destructive
Delete rule
Delete a network monitoring rule for account.
DELETE /accounts/{account_id}/mnm/rules/{rule_id}
Magic Network Monitoring VPC Flow logs
- Write
Generate authentication token for VPC flow logs export.
Generate authentication token for VPC flow logs export.
POST /accounts/{account_id}/mnm/vpc-flows/token
Monetization
- Read
Get account monetization eligibility
Returns the account's latest stored monetization eligibility result.
GET /accounts/{account_id}/monetization - Read
Check account monetization eligibility
Checks the account for Monetization Gateway eligibility and returns its pending, approved, or rejected decision.
POST /accounts/{account_id}/monetization - Read
Get zone monetization eligibility
Returns the zone's latest stored monetization eligibility result.
GET /zones/{zone_id}/monetization - Read
Check zone monetization eligibility
Checks the zone for Monetization Gateway eligibility and enables its entitlement when the decision is approved.
POST /zones/{zone_id}/monetization - Read
List payment rules
Returns the currently deployed Payment Required rules for a zone. A zone with no Payment Required ruleset returns 404.
GET /zones/{zone_id}/monetization/rules - Read
Get a payment rule
Returns a single Payment Required rule identified by its ID.
GET /zones/{zone_id}/monetization/rules/{rule_id} - Write
Update a payment 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.
PATCH /zones/{zone_id}/monetization/rules/{rule_id} - Destructive
Delete all payment rules
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.
DELETE /zones/{zone_id}/monetization/rules - Destructive
Deploy payment ruleset
Replaces the zone's Payment Required ruleset with the submitted desired state. Submit an empty rules array to clear all payment rules.
PUT /zones/{zone_id}/monetization/rules - Destructive
Delete a payment rule
Removes a single Payment Required rule identified by its ID. Every other rule is preserved. Returns the resulting rule collection.
DELETE /zones/{zone_id}/monetization/rules/{rule_id}
Mo Q Relays
- Read
List relays
Lists all MoQ relays for the account. Returns only metadata. Config, status, and tokens are omitted. Results are cursor-paginated (keyset on the `created` timestamp). Use `created_before` / `created_after` with the `created` value of the first/last item in a page to fetch the adjacent page. `result_info` reports the page `count` and the `total` matching the cursor filters.
GET /accounts/{account_id}/moq/relays - Read
Get a relay
Retrieves a single MoQ relay including config and status. Tokens are NOT included.
GET /accounts/{account_id}/moq/relays/{relay_id} - Read
List tokens
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.
GET /accounts/{account_id}/moq/relays/{relay_id}/tokens - Write
Create a relay
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.
POST /accounts/{account_id}/moq/relays - Write
Create a token
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.
POST /accounts/{account_id}/moq/relays/{relay_id}/tokens - Destructive
Delete a relay
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.
DELETE /accounts/{account_id}/moq/relays/{relay_id} - Destructive
Update a relay
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.
PUT /accounts/{account_id}/moq/relays/{relay_id} - Destructive
Revoke a token
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.
DELETE /accounts/{account_id}/moq/relays/{relay_id}/tokens/{jti}
M TLS Certificate Management
- Read
List mTLS 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](/api/resources/client_certificates/methods/list/).
GET /accounts/{account_id}/mtls_certificates - Read
Get mTLS 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](/api/resources/client_certificates/methods/get/).
GET /accounts/{account_id}/mtls_certificates/{mtls_certificate_id} - Read
List mTLS certificate associations
Lists all active associations between the certificate and Cloudflare services.
GET /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations - Write
Upload mTLS 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](/api/resources/client_certificates/methods/create/).
POST /accounts/{account_id}/mtls_certificates - Destructive
Delete mTLS certificate
Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.
DELETE /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}
OAuth Clients
- Read
List OAuth Clients
List all OAuth clients for an account.
GET /accounts/{account_id}/oauth_clients - Read
OAuth Client Details
Get details of a specific OAuth client.
GET /accounts/{account_id}/oauth_clients/{oauth_client_id} - Read
List OAuth Scopes
List all available OAuth scopes. This endpoint requires authentication but has no authorization role requirements.
GET /oauth/scopes - Write
Create OAuth Client
Create a new OAuth client for an account.
POST /accounts/{account_id}/oauth_clients - Write
Update OAuth Client
Update an existing OAuth client. Only include fields you want to update.
PATCH /accounts/{account_id}/oauth_clients/{oauth_client_id} - Write
Rotate OAuth Client 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`.
POST /accounts/{account_id}/oauth_clients/{oauth_client_id}/rotate_secret - Destructive
Delete OAuth Client
Delete an OAuth client.
DELETE /accounts/{account_id}/oauth_clients/{oauth_client_id} - Destructive
Delete Rotated OAuth Client 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.
DELETE /accounts/{account_id}/oauth_clients/{oauth_client_id}/rotate_secret
Integrations
- Read
List integrations
Returns a paginated list of integrations for the account.
GET /accounts/{account_id}/one/integrations - Read
Get integration details
Returns full integration details including use cases and permissions.
GET /accounts/{account_id}/one/integrations/{id} - Write
Create integration
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.
POST /accounts/{account_id}/one/integrations - Write
Update integration
Updates an integration's name, permissions, DLP profiles, use cases, or credentials.
PATCH /accounts/{account_id}/one/integrations/{id} - Write
Pause integration
Pauses an integration, stopping all crawlers.
POST /accounts/{account_id}/one/integrations/{id}/pause - Write
Resume integration
Resumes a paused integration, restarting crawlers.
POST /accounts/{account_id}/one/integrations/{id}/resume - Destructive
Delete integration
Delete an integration by soft-deleting it.
DELETE /accounts/{account_id}/one/integrations/{id}
Pages Project
- Read
List Cloudflare Pages projects
List the Cloudflare Pages projects in an account.
GET /accounts/{account_id}/pages/projects - Read
Get a Cloudflare Pages project
Retrieve the configuration and deployment settings for a Cloudflare Pages project.
GET /accounts/{account_id}/pages/projects/{project_name} - Read
Get upload token
Get a short-lived JWT for Pages Direct Upload asset operations.
GET /accounts/{account_id}/pages/projects/{project_name}/upload-token - Write
Create a Cloudflare Pages project
Create a Cloudflare Pages project for configuring and deploying a site or application.
POST /accounts/{account_id}/pages/projects - Write
Connect a Git repository
Connect a GitHub or GitLab repository to a Cloudflare Pages project to enable Git-based deployments.
POST /accounts/{account_id}/pages/projects/{project_name}/source - Destructive
Delete a Cloudflare Pages project
Permanently delete a Cloudflare Pages project and its deployments.
DELETE /accounts/{account_id}/pages/projects/{project_name} - Destructive
Update a Cloudflare Pages project
Update the build, deployment, source, or environment settings for a Cloudflare Pages project. To delete an environment variable, set its key to `null`.
PATCH /accounts/{account_id}/pages/projects/{project_name} - Destructive
Disconnect a Git repository
Disconnect the Git repository from a Cloudflare Pages project to stop Git-based deployments.
DELETE /accounts/{account_id}/pages/projects/{project_name}/source
Pages Deployment
- Read
List Pages deployments
List the production or preview deployments for a Cloudflare Pages project.
GET /accounts/{account_id}/pages/projects/{project_name}/deployments - Read
Get a Pages deployment
Retrieve the status and details of a Cloudflare Pages deployment.
GET /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id} - Read
Get Pages deployment logs
Retrieve the build logs for a Cloudflare Pages deployment.
GET /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs - Write
Create a Pages deployment
Create a Cloudflare Pages deployment from a Git branch or Direct Upload manifest. Git repositories must already be authorized in Cloudflare Pages.
POST /accounts/{account_id}/pages/projects/{project_name}/deployments - Write
Retry a Pages deployment
Retry a previous Cloudflare Pages deployment.
POST /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry - Write
Roll back a Pages deployment
Roll back production to a previous successful Cloudflare Pages deployment.
POST /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback - Write
Create deployment tail
Start a tail that receives logs and exception data.
POST /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/tails - Destructive
Delete a Pages deployment
Remove a deployment from a Cloudflare Pages project.
DELETE /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id} - Destructive
Delete deployment tail
Deletes a tail from a Pages deployment.
DELETE /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/tails/{tail_id}
Pages Domains
- Read
List Pages custom domains
List the custom domains associated with a Cloudflare Pages project.
GET /accounts/{account_id}/pages/projects/{project_name}/domains - Read
Get a Pages custom domain
Retrieve the configuration and validation status of a custom domain attached to a Cloudflare Pages project.
GET /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name} - Write
Add a Pages custom domain
Attach a custom domain to a Cloudflare Pages project.
POST /accounts/{account_id}/pages/projects/{project_name}/domains - Write
Retry custom domain validation
Retry validation for a custom domain attached to a Cloudflare Pages project.
PATCH /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name} - Destructive
Delete a Pages custom domain
Remove a custom domain from a Cloudflare Pages project.
DELETE /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}
Pages Build Cache
- Destructive
Purge the Pages build cache
Remove cached build artifacts so subsequent builds run without the project's existing build cache.
POST /accounts/{account_id}/pages/projects/{project_name}/purge_build_cache
Ppc stripe
- Read
Gets the stripe config for a crawler
Gets the stripe config for a crawler.
GET /accounts/{account_id}/pay-per-crawl/crawler/stripe - Read
Gets the stripe config for a publisher
Gets the stripe config for a publisher.
GET /accounts/{account_id}/pay-per-crawl/publisher/stripe - Write
Creates the stripe config for a crawler
Creates the stripe config for a crawler.
POST /accounts/{account_id}/pay-per-crawl/crawler/stripe - Write
Creates the stripe config for a publisher
Creates the stripe config for a publisher.
POST /accounts/{account_id}/pay-per-crawl/publisher/stripe - Destructive
Deletes the stripe config for a crawler
Deletes the stripe config for a crawler.
DELETE /accounts/{account_id}/pay-per-crawl/crawler/stripe - Destructive
Deletes the stripe config for a publisher
Deletes the stripe config for a publisher.
DELETE /accounts/{account_id}/pay-per-crawl/publisher/stripe
Ppc crawlers
- Read
List pay-per-crawl crawlers
Lists the crawlers known to pay-per-crawl.
GET /accounts/{account_id}/pay-per-crawl/crawlers
Ppc terms
- Read
Get signed pay-per-crawl terms link
Gets a download link for the account's signed pay-per-crawl terms.
GET /accounts/{account_id}/pay-per-crawl/signature_link - Read
Get pay-per-crawl terms
Gets the pay-per-crawl terms and conditions contract.
GET /accounts/{account_id}/pay-per-crawl/terms - Read
Get pay-per-crawl terms signature status
Gets the account's pay-per-crawl terms signature status.
GET /accounts/{account_id}/pay-per-crawl/terms/signature - Write
Record pay-per-crawl terms activity
Records that an account displayed or agreed to the pay-per-crawl terms.
POST /accounts/{account_id}/pay-per-crawl/terms/signature
Ppc config
- Read
Get pay-per-crawl zone eligibility
Gets whether pay-per-crawl can be enabled for a zone.
GET /zones/{zone_id}/pay-per-crawl/can_be_enabled - Read
Get the pay-per-crawl config
Gets the pay-per-crawl config for a zone including the bot configuration.
GET /zones/{zone_id}/pay-per-crawl/configuration - Write
Set can_be_enabled setting on zones
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.
PATCH /accounts/{account_id}/pay-per-crawl/zones_can_be_enabled - Write
Gets the can_be_enabled zone setting
Provided a list of pay-per-crawl configured zones this method will return whether they can enable PPC or not.
POST /accounts/{account_id}/pay-per-crawl/zones_can_be_enabled/query - Write
Changes pay-per-crawl config for a zone
Changes the pay-per-crawl config for a zone.
PATCH /zones/{zone_id}/pay-per-crawl/configuration - Write
Creates pay-per-crawl config for a zone
Creates the pay-per-crawl config for a zone.
POST /zones/{zone_id}/pay-per-crawl/configuration
Ppu enabled domains
- Read
List enabled Pay Per Use domains
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.
GET /accounts/{account_id}/pay-per-use/enabled-domains
Ppu configuration
- Read
Get pay-per-use operator configuration
Gets the pay-per-use operator configuration for an account, including its read-only non-billable classification timestamp.
GET /accounts/{account_id}/pay-per-use/operator/configuration - Read
Get pay-per-use zone eligibility
Gets whether pay-per-use can be enabled for a zone and the current zone-level grace period.
GET /zones/{zone_id}/pay-per-use/can_be_enabled - Read
Get pay-per-use zone configuration
Gets the pay-per-use configuration, zone-level grace period, and read-only non-billable classification timestamp for a zone.
GET /zones/{zone_id}/pay-per-use/configuration - Write
Update pay-per-use operator configuration
Updates one or more fields of an existing pay-per-use operator configuration. 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.
PATCH /accounts/{account_id}/pay-per-use/operator/configuration - Write
Set pay-per-use zone eligibility
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.
PATCH /accounts/{account_id}/pay-per-use/zones_can_be_enabled - Write
Update pay-per-use zone configuration
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.
PATCH /zones/{zone_id}/pay-per-use/configuration - Destructive
Set pay-per-use operator configuration
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.
PUT /accounts/{account_id}/pay-per-use/operator/configuration
Ppu pricing
- Read
List pay-per-use price proposals
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.
GET /accounts/{account_id}/pay-per-use/proposals - Read
List pay-per-use operators
Lists a paginated set of enabled pay-per-use operators with verified names, matching billing classification, and their prices for a zone.
GET /zones/{zone_id}/pay-per-use/operators - Write
Decide a pay-per-use price proposal
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.
POST /accounts/{account_id}/pay-per-use/proposals - Write
Set a pay-per-use operator price
Proposes a required price, withdraws a pending proposal, accepts an operator's default pay-per-use price, or resumes an accepted price before its scheduled expiry. Propose, accept_default, and resume require an enabled operator with a verified name, an enabled publisher zone, and matching billing classifications.
POST /zones/{zone_id}/pay-per-use/operators/{operator_id}/price - Destructive
Opt out of a pay-per-use operator price
Opts a zone out by scheduling the current accepted pay-per-use operator price to expire at the start of the next UTC month. Use the withdraw action for a pending proposal.
DELETE /zones/{zone_id}/pay-per-use/operators/{operator_id}/price
Ppu usage reports
- Write
Submit a participant usage report
Validates and submits a usage report for an active Pay Per Use participant. The complete report is rejected if any item is invalid.
POST /accounts/{account_id}/pay-per-use/usage-reports
Ppu usage stats
- Read
Get pay-per-use usage statistics
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.
GET /accounts/{account_id}/pay-per-use/usage-stats - Read
Get pay-per-use usage statistics for a zone
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.
GET /zones/{zone_id}/pay-per-use/usage-stats
Account Payment Methods
- Read
List Payment Methods
Lists all payment methods for an account.
GET /accounts/{account_id}/payment-methods - Read
Get Payment Method
Gets a specific payment method for an account.
GET /accounts/{account_id}/payment-methods/{payment_method_id} - Write
Create Payment Method
Creates a new payment method for an account.
POST /accounts/{account_id}/payment-methods - Write
Set Default Payment Method
Sets a payment method as the default for an account.
POST /accounts/{account_id}/payment-methods/{payment_method_id}/set-as-default - Destructive
Delete Payment Method
Deletes a payment method from an account.
DELETE /accounts/{account_id}/payment-methods/{payment_method_id} - Destructive
Update Payment Method
Updates a payment method for an account.
PUT /accounts/{account_id}/payment-methods/{payment_method_id}
Magic PCAP collection
- Read
List packet capture requests
Lists all packet capture requests for an account.
GET /accounts/{account_id}/pcaps - Read
List PCAPs Bucket Ownership
List all buckets configured for use with PCAPs API.
GET /accounts/{account_id}/pcaps/ownership - Read
Validate buckets for full packet captures
Validates buckets added to the packet captures API.
POST /accounts/{account_id}/pcaps/ownership/validate - Read
Get PCAP request
Get information for a PCAP request by id.
GET /accounts/{account_id}/pcaps/{pcap_id} - Read
Download Simple PCAP
Download PCAP information into a file. Response is a binary PCAP file.
GET /accounts/{account_id}/pcaps/{pcap_id}/download - Write
Create PCAP request
Create new PCAP request for account.
POST /accounts/{account_id}/pcaps - Write
Add buckets for full packet captures
Adds an AWS or GCP bucket to use with full packet captures.
POST /accounts/{account_id}/pcaps/ownership - Destructive
Delete buckets for full packet captures
Deletes buckets added to the packet captures API.
DELETE /accounts/{account_id}/pcaps/ownership/{ownership_id} - Destructive
Stop full PCAP
Stop full PCAP.
PUT /accounts/{account_id}/pcaps/{pcap_id}/stop
workers_pipelines_other
- Read
[DEPRECATED] List Pipelines (deprecated)
[DEPRECATED] List, filter, and paginate pipelines in an account. Use the new /pipelines/v1/pipelines endpoint instead.
GET /accounts/{account_id}/pipelines - Read
[DEPRECATED] Get Pipeline (deprecated)
[DEPRECATED] Get configuration of a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
GET /accounts/{account_id}/pipelines/{pipeline_name} - Write
[DEPRECATED] Create Pipeline (deprecated)
[DEPRECATED] Create a new pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
POST /accounts/{account_id}/pipelines - Destructive
[DEPRECATED] Delete Pipeline (deprecated)
[DEPRECATED] Delete a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
DELETE /accounts/{account_id}/pipelines/{pipeline_name} - Destructive
[DEPRECATED] Update Pipeline (deprecated)
[DEPRECATED] Update an existing pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
PUT /accounts/{account_id}/pipelines/{pipeline_name}
Workers pipelines other
- Read
List Pipelines
List/Filter Pipelines in Account.
GET /accounts/{account_id}/pipelines/v1/pipelines - Read
Get Pipeline Details
Get Pipeline details.
GET /accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id} - Read
List Sinks
List/Filter Sinks in Account.
GET /accounts/{account_id}/pipelines/v1/sinks - Read
Get Sink Details
Get Sink Details.
GET /accounts/{account_id}/pipelines/v1/sinks/{sink_id} - Read
List Streams
List/Filter Streams in Account.
GET /accounts/{account_id}/pipelines/v1/streams - Read
Get Stream Details
Get Stream Details.
GET /accounts/{account_id}/pipelines/v1/streams/{stream_id} - Read
Validate SQL
Validates that the Pipelines SQL is correct.
POST /accounts/{account_id}/pipelines/v1/validate_sql - Write
Create Pipeline
Create a new Pipeline.
POST /accounts/{account_id}/pipelines/v1/pipelines - Write
Create Sink
Create a new Sink.
POST /accounts/{account_id}/pipelines/v1/sinks - Write
Create Stream
Create a new Stream.
POST /accounts/{account_id}/pipelines/v1/streams - Write
Update Stream
Update a Stream.
PATCH /accounts/{account_id}/pipelines/v1/streams/{stream_id} - Destructive
Delete Pipeline
Delete Pipeline in Account.
DELETE /accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id} - Destructive
Delete Sink
Delete Sink in Account.
DELETE /accounts/{account_id}/pipelines/v1/sinks/{sink_id} - Destructive
Delete Stream
Delete Stream in Account.
DELETE /accounts/{account_id}/pipelines/v1/streams/{stream_id}
R2 Catalog Management
- Read
List R2 catalogs (deprecated)
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.
GET /accounts/{account_id}/r2-catalog - Read
Get R2 catalog details (deprecated)
Retrieve detailed information about a specific R2 catalog by bucket name. Returns catalog status, maintenance configuration, and credential status.
GET /accounts/{account_id}/r2-catalog/{bucket_name} - Write
Disable R2 catalog (deprecated)
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.
POST /accounts/{account_id}/r2-catalog/{bucket_name}/disable - Write
Enable R2 bucket as a catalog (deprecated)
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.
POST /accounts/{account_id}/r2-catalog/{bucket_name}/enable - Destructive
Delete R2 catalog metadata (deprecated)
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.
POST /accounts/{account_id}/r2-catalog/{bucket_name}/delete
R2 Object
- Read
List Objects
Lists objects in an R2 bucket. Returns object metadata including key, size, etag, last modified date, HTTP metadata, and custom metadata. For most workloads, we recommend using R2's [S3-compatible API](https://developers.cloudflare.com/r2/api/s3/api/) or a [Worker with an R2 binding](https://developers.cloudflare.com/r2/api/workers/workers-api-reference/) instead.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/objects - Read
Get Object
Retrieves an object from an R2 bucket. Returns the object body along with metadata headers. For most workloads, we recommend using R2's [S3-compatible API](https://developers.cloudflare.com/r2/api/s3/api/) or a [Worker with an R2 binding](https://developers.cloudflare.com/r2/api/workers/workers-api-reference/) instead.
GET /accounts/{account_id}/r2/buckets/{bucket_name}/objects/{object_key} - Destructive
Delete Objects
Deletes the listed objects from an R2 bucket. Provide a JSON array of 1 to 1000 object keys in the request body. If any key cannot be deleted (for example, because it does not exist or is locked), the remaining keys are still deleted, but the response is HTTP 200 with `success: false`, `result: null` and one entry in `errors` per failed key. The entries in `errors` do not identify which key failed. To delete every object under a prefix, or to empty a bucket, create a `prefixDelete` job with the Create Bucket Job endpoint instead. The `prefix` query parameter on this endpoint is deprecated; it creates the same job, but responses to it carry a `Deprecation` header and a message pointing to Create Bucket Job. For most workloads, we recommend using R2's [S3-compatible API](https://developers.cloudflare.com/r2/api/s3/api/) or a [Worker with an R2 binding](https://developers.cloudflare.com/r2/api/workers/workers-api-reference/) instead.
DELETE /accounts/{account_id}/r2/buckets/{bucket_name}/objects - Destructive
Delete Object
Deletes an object from an R2 bucket. For most workloads, we recommend using R2's [S3-compatible API](https://developers.cloudflare.com/r2/api/s3/api/) or a [Worker with an R2 binding](https://developers.cloudflare.com/r2/api/workers/workers-api-reference/) instead.
DELETE /accounts/{account_id}/r2/buckets/{bucket_name}/objects/{object_key} - Destructive
Upload Object
Uploads an object to an R2 bucket. The object body is provided as the request body. Returns metadata about the uploaded object. The maximum upload size for this endpoint is 300 MB. For most workloads, we recommend using R2's [S3-compatible API](https://developers.cloudflare.com/r2/api/s3/api/) or a [Worker with an R2 binding](https://developers.cloudflare.com/r2/api/workers/workers-api-reference/) instead.
PUT /accounts/{account_id}/r2/buckets/{bucket_name}/objects/{object_key}
R2 Account
- Read
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.
GET /accounts/{account_id}/r2/metrics
Analytics
- Read
Fetch day-wise session and recording analytics data for an App
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.
GET /accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise
Live streams
- Read
Fetch day-wise analytics data for your livestreams
Returns day-wise livestream analytics for the specified time range.
GET /accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/daywise - Read
Fetch complete analytics data for your livestreams
Returns livestream analytics for the specified time range.
GET /accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall - Read
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.
GET /accounts/{account_id}/realtime/kit/{app_id}/livestreams - Read
Fetch livestream session details using livestream session ID
Returns livestream session details for the given livestream session ID. Retrieve the `livestream_session_id`using the `Fetch livestream session details using a session ID` API.
GET /accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id} - Read
Fetch livestream details using 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.
GET /accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id} - Read
Fetch 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.
GET /accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session - Read
Fetch active livestreams for a meeting
Returns details of all active livestreams for the given meeting ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream - Read
Fetch livestream session details for a meeting
Returns livestream session details for the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.
GET /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestream - Read
Fetch livestream session details using a session ID
Returns livestream session details for the given session ID. Retreive the session ID using the `Fetch all sessions of an App` API.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/livestream-sessions - Write
Stop livestreaming a meeting
Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop - Write
Start livestreaming a meeting
Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams
Meetings
- Read
Fetch all meetings for an App
Returns all meetings for the given App ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/meetings - Read
Fetch a meeting for an App
Returns a meeting details in an App for the given meeting ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id} - Read
Fetch all participants of a meeting
Returns all participants detail for the given meeting ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants - Read
Fetch a participant's detail
Returns a participant details for the given meeting and participant ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id} - Write
Create a meeting
Create a meeting for the given App ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings - Write
Update a meeting
Updates a meeting in an App for the given meeting ID.
PATCH /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id} - Write
Add a participant
Adds a participant to the given meeting ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants - Write
Edit a participant's detail
Updates a participant's details for the given meeting and participant ID.
PATCH /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id} - Write
Refresh participant's authentication token
Regenerates participant's authentication token for the given meeting and participant ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}/token - Destructive
Replace a meeting
Replaces all the details for the given meeting ID.
PUT /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id} - Destructive
Delete a participant
Deletes a participant for the given meeting and participant ID.
DELETE /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id} - Destructive
Replace a participant's detail
Replaces a participant's details for the given meeting and participant ID.
PUT /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id} - Destructive
Revoke participant's authentication token
Revokes a previously issued participant authentication token without deleting the participant. Other tokens issued to the participant remain valid.
DELETE /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}/token
Active session
- Read
Fetch details of an active session
Returns details of an ongoing active session for the given meeting ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session - Write
Kick participants from an active session
Kicks one or more participants from an active session using user ID or custom participant ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick - Write
Kick all participants
Kicks all participants from an active session for the given meeting ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick-all - Write
Mute participants of an active session
Mutes one or more participants from an active session using user ID or custom participant ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute - Write
Mute all participants
Mutes all participants of an active session for the given meeting ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute-all - Write
Create a poll
Creates a new poll in an active session for the given meeting ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll
Presets
- Read
Fetch all presets
Fetches all the presets belonging to an App.
GET /accounts/{account_id}/realtime/kit/{app_id}/presets - Read
Fetch details of a preset
Fetches details of a preset using the provided preset ID
GET /accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id} - Write
Create a preset
Creates a preset belonging to the current App
POST /accounts/{account_id}/realtime/kit/{app_id}/presets - Write
Update a preset
Update a preset by the provided preset ID
PATCH /accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id} - Destructive
Delete a preset
Deletes a preset using the provided preset ID
DELETE /accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id} - Destructive
Replace a preset
Replace all details for the preset using the provided preset ID.
PUT /accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}
Recordings
- Read
Fetch all recordings for an App
Returns all recordings for an App. If the `meeting_id` parameter is passed, returns all recordings for the given meeting ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/recordings - Read
Fetch active recording
Returns the active recording details for the given meeting ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id} - Read
Fetch details of a recording
Returns details of a recording for the given recording ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id} - Write
Start recording a meeting
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.
POST /accounts/{account_id}/realtime/kit/{app_id}/recordings - Write
Start recording participant audio tracks
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](/realtime/realtimekit/recording-guide/track-recording/).
POST /accounts/{account_id}/realtime/kit/{app_id}/recordings/track - Destructive
Pause/Resume/Stop recording
Pause/Resume/Stop a given recording ID.
PUT /accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}
Sessions
- Read
Fetch all sessions of an App
Returns details of all sessions of an App.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions - Read
Fetch details of peer
Returns participant details for the given peer ID along with call statistics.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id} - Read
Fetch details of a session
Returns data of the given session ID including recording details.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id} - Read
Fetch all chat messages of a session
Returns a URL to download all chat messages of the session ID in CSV format.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat - Read
Fetch participants list of a session
Returns a list of participants for the given session ID.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants - Read
Fetch details of a participant
Returns details of the given participant ID for the given session ID. Use the peer report endpoint to retrieve call statistics.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id} - Read
Fetch summary of transcripts for a session
Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary - Read
Fetch the complete transcript for a session
Returns a URL to download the transcript for the session ID in CSV format.
GET /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript - Write
Generate summary of Transcripts for the session
Trigger Summary generation of Transcripts for the session ID.
POST /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary
Domain Discovery
- Read
Check domain availability
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`. **Important:** Unlike the Search endpoint, these results are authoritative and reflect current registry status. Always check availability immediately before registration as domain status can change rapidly. **Note:** This endpoint uses POST to accept a list of domains in the request body. It is a read-only operation — it does not create, modify, or reserve any domains. ### Extension support Only domains on extensions supported for programmatic registration by this API can be registered. If you check a domain on an unsupported extension, the response will include `registrable: false` with a `reason` field explaining why: - `extension_not_supported_via_api` — Cloudflare Registrar supports this extension in the dashboard, but it is not yet available for programmatic registration via this API. Register via `https://dash.cloudflare.com/{account_id}/domains/registrations` instead. - `extension_not_supported` — This extension is not supported by Cloudflare Registrar. - `extension_disallows_registration` — The extension's registry has temporarily or permanently frozen new registrations. No registrar can register domains on this extension at this time. - `domain_premium` — The domain is premium priced. Premium registration is not currently supported by this API. - `domain_unavailable` — The domain is already registered, reserved, or otherwise not available for registration on a supported extension. The `reason` field is only present when `registrable` is `false`. ### Behavior - Maximum 20 domains per request - Pricing is only returned for domains where `registrable: true` - Results are not cached; each request queries the registry ### Workflow 1. Call this endpoint with domains the user wants to register. 2. For each domain where `registrable: true`, present pricing to the user. 3. If `tier: premium`, note that premium registration is not currently supported by this API and do not proceed to `POST /registrations`. 4. Proceed to `POST /registrations` only for supported non-premium domains.
POST /accounts/{account_id}/registrar-sandbox/domain-check - Read
Search for available domains
Searches for domain name suggestions based on a keyword, phrase, or partial domain name. Returns a list of potentially available domains with pricing information. **Important:** Results are non-authoritative and based on cached data. Always use the `/domain-check` endpoint to verify real-time availability before attempting registration. Suggestions are scoped to extensions supported for programmatic registration via this API (`POST /registrations`). Domains on unsupported extensions will not appear in results, even if they are available at the registry level. ### Use cases - Brand name discovery (e.g., "acme corp" → acmecorp.com, acmecorp.dev) - Keyword-based suggestions (e.g., "coffee shop" → coffeeshop.com, mycoffeeshop.net) - Alternative extension discovery (e.g., "example.com" → example.com, example.app, example.xyz) ### Workflow 1. Call this endpoint with a keyword or domain name. 2. Present suggestions to the user. 3. Call `/domain-check` with the user's chosen domains to confirm real-time availability and pricing. 4. Proceed to `POST /registrations` only for supported non-premium domains where the Check response returns `registrable: true`. **Note:** Searching with just a domain extension (e.g., "com" or ".app") is not supported. Provide a keyword or domain name.
GET /accounts/{account_id}/registrar-sandbox/domain-search - Read
Check domain availability
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`. **Important:** Unlike the Search endpoint, these results are authoritative and reflect current registry status. Always check availability immediately before registration as domain status can change rapidly. **Note:** This endpoint uses POST to accept a list of domains in the request body. It is a read-only operation — it does not create, modify, or reserve any domains. ### Extension support Only domains on extensions supported for programmatic registration by this API can be registered. If you check a domain on an unsupported extension, the response will include `registrable: false` with a `reason` field explaining why: - `extension_not_supported_via_api` — Cloudflare Registrar supports this extension in the dashboard, but it is not yet available for programmatic registration via this API. Register via `https://dash.cloudflare.com/{account_id}/domains/registrations` instead. - `extension_not_supported` — This extension is not supported by Cloudflare Registrar. - `extension_disallows_registration` — The extension's registry has temporarily or permanently frozen new registrations. No registrar can register domains on this extension at this time. - `domain_premium` — The domain is premium priced. Premium registration is not currently supported by this API. - `domain_unavailable` — The domain is already registered, reserved, or otherwise not available for registration on a supported extension. The `reason` field is only present when `registrable` is `false`. ### Behavior - Maximum 20 domains per request - Pricing is only returned for domains where `registrable: true` - Results are not cached; each request queries the registry ### Workflow 1. Call this endpoint with domains the user wants to register. 2. For each domain where `registrable: true`, present pricing to the user. 3. If `tier: premium`, note that premium registration is not currently supported by this API and do not proceed to `POST /registrations`. 4. Proceed to `POST /registrations` only for supported non-premium domains.
POST /accounts/{account_id}/registrar/domain-check - Read
Search for available domains
Searches for domain name suggestions based on a keyword, phrase, or partial domain name. Returns a list of potentially available domains with pricing information. **Important:** Results are non-authoritative and based on cached data. Always use the `/domain-check` endpoint to verify real-time availability before attempting registration. Suggestions are scoped to extensions supported for programmatic registration via this API (`POST /registrations`). Domains on unsupported extensions will not appear in results, even if they are available at the registry level. ### Use cases - Brand name discovery (e.g., "acme corp" → acmecorp.com, acmecorp.dev) - Keyword-based suggestions (e.g., "coffee shop" → coffeeshop.com, mycoffeeshop.net) - Alternative extension discovery (e.g., "example.com" → example.com, example.app, example.xyz) ### Workflow 1. Call this endpoint with a keyword or domain name. 2. Present suggestions to the user. 3. Call `/domain-check` with the user's chosen domains to confirm real-time availability and pricing. 4. Proceed to `POST /registrations` only for supported non-premium domains where the Check response returns `registrable: true`. **Note:** Searching with just a domain extension (e.g., "com" or ".app") is not supported. Provide a keyword or domain name.
GET /accounts/{account_id}/registrar/domain-search - Read
Check domain transfer eligibility
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`. **Note:** This endpoint uses POST to accept a list of domains in the request body. It is a read-only operation — it does not create, modify, or reserve any domains. ### Behavior - Maximum 10 domains per request - Pricing is only returned for domains where `transferable: true` - Results are not cached; each request queries the registry & other needed upstreams ## Extension Support All `.uk` extensions (`.uk`, `.co.uk`, etc) do not support auth codes. As such, Cloudflare will ignore the `auth_code` section of this request for `.uk` domains. This means that a `.uk` domain depends on public data to obtain domain information, so it might be a few minutes outdated. ### Workflow 1. Call this endpoint with domains the user wants to transfer. 2. For each domain where `transferable: true`, present pricing to the user. 3. For each domain where `transferable: false`, present reasons to the user 4. Proceed to `POST /registrations/:domain_name/transfer-in` only for the `transferable: true` domains.
POST /accounts/{account_id}/registrar/domain-transfer-check
Extension
- Read
List extensions
Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on each supported extension (TLD). This endpoint uses cursor-based pagination. Results are ordered by extension name by default. To fetch the next page, pass the `cursor` value from the `result_info` object in the response as the `cursor` query parameter in your next request. An empty `cursor` string indicates there are no more pages. Supports HTTP conditional GET via `ETag`. Include the `ETag` value from a previous response in an `If-None-Match` header to receive a `304 Not Modified` when the data has not changed.
GET /accounts/{account_id}/registrar-sandbox/extensions - Read
Get extension
Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on a specific extension (TLD). Supports HTTP conditional GET via `ETag`. Include the `ETag` value from a previous response in an `If-None-Match` header to receive a `304 Not Modified` when the data has not changed.
GET /accounts/{account_id}/registrar-sandbox/extensions/{extension} - Read
List extensions
Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on each supported extension (TLD). This endpoint uses cursor-based pagination. Results are ordered by extension name by default. To fetch the next page, pass the `cursor` value from the `result_info` object in the response as the `cursor` query parameter in your next request. An empty `cursor` string indicates there are no more pages. Supports HTTP conditional GET via `ETag`. Include the `ETag` value from a previous response in an `If-None-Match` header to receive a `304 Not Modified` when the data has not changed.
GET /accounts/{account_id}/registrar/extensions - Read
Get extension
Returns metadata and JSON Schema documents describing the expected input structure for registration and transfer operations on a specific extension (TLD). Supports HTTP conditional GET via `ETag`. Include the `ETag` value from a previous response in an `If-None-Match` header to receive a `304 Not Modified` when the data has not changed.
GET /accounts/{account_id}/registrar/extensions/{extension}
Registrar Registration
- Read
List Registrations
Returns a paginated list of domain registrations owned by the account. This endpoint uses cursor-based pagination. Results are ordered by registration date by default. To fetch the next page, pass the `cursor` value from the `result_info` object in the response as the `cursor` query parameter in your next request. An empty `cursor` string indicates there are no more pages.
GET /accounts/{account_id}/registrar-sandbox/registrations - Read
Get Registration
Returns the current state of a domain registration. This is the canonical read endpoint for a domain you own. It returns the full registration resource including current settings and expiration. When the registration resource is ready, both `created_at` and `expires_at` are present in the response.
GET /accounts/{account_id}/registrar-sandbox/registrations/{domain_name} - Read
Get Registration Status
Returns the current status of a domain registration workflow. Use this endpoint to poll for completion when the POST response returned `202 Accepted`. The URL is provided in the `links.self` field of the workflow status response. Poll this endpoint until the workflow reaches a terminal state or a state that requires user attention. **Terminal states:** `succeeded` and `failed` are terminal and always have `completed: true`. **Non-terminal states:** - `action_required` has `completed: false` and will not resolve on its own. The workflow is paused pending user intervention. - `blocked` has `completed: false` and indicates the workflow is waiting on a third party such as the extension registry or losing registrar. Continue polling while informing the user of the delay. Use increasing backoff between polls. When `state: blocked`, use a longer polling interval and do not poll indefinitely. A naive polling loop that only checks `completed` can run indefinitely when `state: action_required`. Break explicitly on `action_required`: ```js let status; do { await new Promise(r => setTimeout(r, 2000)); status = await cloudflare.request({ method: 'GET', path: reg.result.links.self, }); } while ( !status.result.completed && status.result.state !== 'action_required' ); if (status.result.state === 'action_required') { // Surface context.action and context.confirmation_sent_to to the user. // Do not re-submit the registration request. } ```
GET /accounts/{account_id}/registrar-sandbox/registrations/{domain_name}/registration-status - Read
Get Update Status
Returns the current status of a domain update workflow. Use this endpoint to poll for completion when the PATCH response returned `202 Accepted`. The URL is provided in the `links.self` field of the workflow status response. Poll this endpoint until the workflow reaches a terminal state or a state that requires user attention. Use increasing backoff between polls. When the workflow remains blocked on a third party, use a longer polling interval and do not poll indefinitely.
GET /accounts/{account_id}/registrar-sandbox/registrations/{domain_name}/update-status - Read
List Registrations
Returns a paginated list of domain registrations owned by the account. This endpoint uses cursor-based pagination. Results are ordered by registration date by default. To fetch the next page, pass the `cursor` value from the `result_info` object in the response as the `cursor` query parameter in your next request. An empty `cursor` string indicates there are no more pages.
GET /accounts/{account_id}/registrar/registrations - Read
Get Registration
Returns the current state of a domain registration. This is the canonical read endpoint for a domain you own. It returns the full registration resource including current settings and expiration. When the registration resource is ready, both `created_at` and `expires_at` are present in the response.
GET /accounts/{account_id}/registrar/registrations/{domain_name} - Read
Get Registration Status
Returns the current status of a domain registration workflow. Use this endpoint to poll for completion when the POST response returned `202 Accepted`. The URL is provided in the `links.self` field of the workflow status response. Poll this endpoint until the workflow reaches a terminal state or a state that requires user attention. **Terminal states:** `succeeded` and `failed` are terminal and always have `completed: true`. **Non-terminal states:** - `action_required` has `completed: false` and will not resolve on its own. The workflow is paused pending user intervention. - `blocked` has `completed: false` and indicates the workflow is waiting on a third party such as the extension registry or losing registrar. Continue polling while informing the user of the delay. Use increasing backoff between polls. When `state: blocked`, use a longer polling interval and do not poll indefinitely. A naive polling loop that only checks `completed` can run indefinitely when `state: action_required`. Break explicitly on `action_required`: ```js let status; do { await new Promise(r => setTimeout(r, 2000)); status = await cloudflare.request({ method: 'GET', path: reg.result.links.self, }); } while ( !status.result.completed && status.result.state !== 'action_required' ); if (status.result.state === 'action_required') { // Surface context.action and context.confirmation_sent_to to the user. // Do not re-submit the registration request. } ```
GET /accounts/{account_id}/registrar/registrations/{domain_name}/registration-status - Read
Get Update Status
Returns the current status of a domain update workflow. Use this endpoint to poll for completion when the PATCH response returned `202 Accepted`. The URL is provided in the `links.self` field of the workflow status response. Poll this endpoint until the workflow reaches a terminal state or a state that requires user attention. Use increasing backoff between polls. When the workflow remains blocked on a third party, use a longer polling interval and do not poll indefinitely.
GET /accounts/{account_id}/registrar/registrations/{domain_name}/update-status - Write
Create Registration
Starts a domain registration workflow. ### Prerequisites - The account must not already be at the maximum supported domain limit. A single account may own up to 500 domains in total across registrations created through either the dashboard or this API. - The domain must be on a supported extension for programmatic registration. - Use `POST /domain-check` immediately before calling this endpoint to confirm real-time availability and pricing. ### Defaults - `years`: defaults to the extension's minimum registration period (1 year for most extensions, but varies — for example, `.ai` (if supported) requires a minimum of 2 years). - `auto_renew`: defaults to `false`. Setting it to `true` is an explicit opt-in authorizing Cloudflare to charge the account's default payment method up to 30 days before domain expiry to renew the registration. Renewal pricing may change over time based on registry pricing. - `privacy_mode`: defaults to `redaction`. ### Premium domains Premium domain registration is not currently supported by this API. If `POST /domain-check` returns `tier: premium`, do not call this endpoint for that domain. ### Response behavior By default, the server holds the connection for a bounded, server-defined amount of time while the registration completes. Most registrations finish within this window and return `201 Created` with a completed workflow status. If the registration is still processing after this synchronous wait window, the server returns `202 Accepted`. Poll the URL in `links.self` to track progress. To skip the wait and receive an immediate `202`, send `Prefer: respond-async`.
POST /accounts/{account_id}/registrar-sandbox/registrations - Write
Update Registration
Updates an existing domain registration. By default, the server holds the connection for a bounded, server-defined amount of time while the update completes. Most updates finish within this window and return `200 OK` with a completed workflow status. If the update is still processing after this synchronous wait window, the server returns `202 Accepted`. Poll the URL in `links.self` to track progress. To skip the wait and receive an immediate `202`, send `Prefer: respond-async`. This endpoint currently supports updating `auto_renew` only.
PATCH /accounts/{account_id}/registrar-sandbox/registrations/{domain_name} - Write
Create Registration
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. ### Prerequisites - The account must have a billing profile with a valid default payment method. Set this up at `https://dash.cloudflare.com/{account_id}/billing/payment-info`. - The account must not already be at the maximum supported domain limit. A single account may own up to 500 domains in total across registrations created through either the dashboard or this API. - The domain must be on a supported extension for programmatic registration. - Use `POST /domain-check` immediately before calling this endpoint to confirm real-time availability and pricing. ### Supported extensions This API supports programmatic registration for all extensions supported by the dashboard experience, with the following exceptions: `giving`, `mom`, `inc`, `lol`, `sh`, `link`, `cc`, `new` Cloudflare Registrar supports 400+ extensions in the dashboard. Extensions listed above can be registered at `https://dash.cloudflare.com/{account_id}/domains/registrations`. ### Express mode The only required field is `domain_name`. If `contacts` is omitted, the system uses the account's default address book entry as the registrant. If no default exists and no contact is provided, the request fails. Set up a default address book entry and accept the required agreement at `https://dash.cloudflare.com/{account_id}/domains/registrations`. ### Defaults - `years`: defaults to the extension's minimum registration period (1 year for most extensions, but varies — for example, `.ai` (if supported) requires a minimum of 2 years). - `auto_renew`: defaults to `false`. Setting it to `true` is an explicit opt-in authorizing Cloudflare to charge the account's default payment method up to 30 days before domain expiry to renew the registration. Renewal pricing may change over time based on registry pricing. - `privacy_mode`: defaults to `redaction`. ### Premium domains Premium domain registration is not currently supported by this API. If `POST /domain-check` returns `tier: premium`, do not call this endpoint for that domain. ### Response behavior By default, the server holds the connection for a bounded, server-defined amount of time while the registration completes. Most registrations finish within this window and return `201 Created` with a completed workflow status. If the registration is still processing after this synchronous wait window, the server returns `202 Accepted`. Poll the URL in `links.self` to track progress. To skip the wait and receive an immediate `202`, send `Prefer: respond-async`.
POST /accounts/{account_id}/registrar/registrations - Write
Update Registration
Updates an existing domain registration. By default, the server holds the connection for a bounded, server-defined amount of time while the update completes. Most updates finish within this window and return `200 OK` with a completed workflow status. If the update is still processing after this synchronous wait window, the server returns `202 Accepted`. Poll the URL in `links.self` to track progress. To skip the wait and receive an immediate `202`, send `Prefer: respond-async`. This endpoint currently supports updating `auto_renew` only.
PATCH /accounts/{account_id}/registrar/registrations/{domain_name}
Registrar Domains
- Read
List domains (deprecated)
Lists domains handled by Registrar.
GET /accounts/{account_id}/registrar/domains - Read
Get domain (deprecated)
Show individual domain.
GET /accounts/{account_id}/registrar/domains/{domain_name} - Destructive
Update domain (deprecated)
Updates an individual domain.
PUT /accounts/{account_id}/registrar/domains/{domain_name}
Registrar Transfer
- Read
Get Transfer Status
Returns the current status of a domain transfer workflow. Use this endpoint to poll transfer progress after initiating a transfer with `POST /accounts/{account_id}/registrar/registrations/{domain_name}/transfer-in`. The URL is provided in the `links.self` field of the transfer response. ### Transfer timelines Transfers typically take 1–10 days due to ICANN-mandated approval windows. ### Workflow states **Terminal states:** `succeeded` and `failed` are terminal and always have `completed: true`. **Non-terminal states:** - `in_progress`: Transfer has been submitted to the registry and is being processed. Continue polling. - `blocked`: The workflow is waiting on the losing registrar or registry to release the domain. This is the **most common state** for transfers and is entirely normal — it means the ICANN transfer approval window is in effect. The losing registrar has up to 5 days to approve or reject. Continue polling with longer intervals (e.g., every 30–60 minutes). - `action_required`: The user needs to take action (e.g., the FOA email needs to be accepted). See `context` for details on what is needed. - `pending`: Transfer workflow created but not yet started processing. ### Polling guidance Adjust your polling interval based on the current workflow state: - `pending` or `in_progress`: Poll every 30 seconds. - `blocked`: The transfer is waiting on a third party (e.g., losing registrar approval). Poll every 30–60 minutes. - `action_required`: Stop polling. The workflow will not advance until the user takes action. Check `context` for details on what is needed. - `succeeded` or `failed`: Terminal — stop polling.
GET /accounts/{account_id}/registrar/registrations/{domain_name}/transfer-in-status - Write
Initiate Transfer
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. ### How transfers work Domain transfers move a domain from another registrar to Cloudflare. Transfers typically take 1-10 days due to ICANN-mandated approval windows. ### Prerequisites - The domain must already have a zone in the Cloudflare account (added through the dashboard or zone API). - The zone must have DNSSec disabled. - For billable transfers (i.e. extensions with non-zero transfer pricing), the account must have a billing profile with a valid default payment method. Set this up at `https://dash.cloudflare.com/{account_id}/billing/payment-info`. - The domain must be unlocked at the current registrar. - An authorization/EPP code from the current registrar is required, except for UK extensions — see Auth code below. ### Auth code An authorization code (also called EPP code, transfer key, or auth-info code) is required for most extensions, with the exception of UK extensions. Obtain this from your current registrar's control panel. The auth code in the request body must be base64-encoded per RFC 4648 §4 (standard alphabet, no line breaks). ### Response behavior Successful transfer initiation returns `202 Accepted`. Validation or initiation failures return the documented `4XX` responses. Poll `GET /accounts/{account_id}/registrar/registrations/{domain_name}/transfer-in-status` to track progress. ### Premium domains Premium domain transfers are not currently supported by this API. Please use the [dashboard](https://dash.cloudflare.com/) for now. ### Billing The account's default payment method is charged upon successful transfer completion, unless the extension has zero transfer pricing (e.g. UK extensions). The transfer adds time to the domain's existing expiration date (typically 1 year).
POST /accounts/{account_id}/registrar/registrations/{domain_name}/transfer-in
Reports other
- Read
Get an account industry
Gets the industry classification for an account.
GET /accounts/{account_id}/reporting/industry - Read
List reporting policies
Lists all reporting policies for an account.
GET /accounts/{account_id}/reporting/policies - Read
Get a reporting policy
Gets a reporting policy by identifier.
GET /accounts/{account_id}/reporting/policies/{policy_id} - Read
List generated reports
Lists all generated reports for an account.
GET /accounts/{account_id}/reporting/reports - Read
Get a generated report
Gets a generated report by identifier.
GET /accounts/{account_id}/reporting/reports/{report_id} - Write
Update an account industry
Updates the industry classification for an account.
PATCH /accounts/{account_id}/reporting/industry
Account Request Tracer
- Write
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.
POST /accounts/{account_id}/request-tracer/trace
Account Roles
- Read
List Roles (deprecated)
Get all available roles for an account.
GET /accounts/{account_id}/roles - Read
Role Details (deprecated)
Get information about a specific role for an account.
GET /accounts/{account_id}/roles/{role_id}
Lists
- Read
Get lists
Fetches all lists in the account.
GET /accounts/{account_id}/rules/lists - Read
Get bulk operation status
Gets the current status of an asynchronous operation on a list. The `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.
GET /accounts/{account_id}/rules/lists/bulk_operations/{operation_id} - Read
Get a list
Fetches the details of a list.
GET /accounts/{account_id}/rules/lists/{list_id} - Read
Get list items
Fetches all the items in the list.
GET /accounts/{account_id}/rules/lists/{list_id}/items - Read
Get a list item
Fetches a list item in the list.
GET /accounts/{account_id}/rules/lists/{list_id}/items/{item_id} - Write
Create a list
Creates a new list of the specified kind.
POST /accounts/{account_id}/rules/lists - Write
Create list items
Appends new items to the list. This operation is asynchronous. To get the current operation status, invoke the `Get bulk operation status` endpoint with the returned `operation_id`. There is a limit of 1 pending bulk operation per account. If an outstanding bulk operation is in progress, the request will be rejected.
POST /accounts/{account_id}/rules/lists/{list_id}/items - Destructive
Delete a list
Deletes a specific list and all its items.
DELETE /accounts/{account_id}/rules/lists/{list_id} - Destructive
Update a list
Updates the description of a list.
PUT /accounts/{account_id}/rules/lists/{list_id} - Destructive
Delete list items
Removes one or more items from a list. This operation is asynchronous. To get the current operation status, invoke the `Get bulk operation status` endpoint with the returned `operation_id`. There is a limit of 1 pending bulk operation per account. If an outstanding bulk operation is in progress, the request will be rejected.
DELETE /accounts/{account_id}/rules/lists/{list_id}/items - Destructive
Update all list items
Removes all existing items from the list and adds the provided items to the list. This operation is asynchronous. To get the current operation status, invoke the `Get bulk operation status` endpoint with the returned `operation_id`. There is a limit of 1 pending bulk operation per account. If an outstanding bulk operation is in progress, the request will be rejected.
PUT /accounts/{account_id}/rules/lists/{list_id}/items
Account Rulesets
- Read
List account rulesets
Fetches all rulesets at the account level.
GET /accounts/{account_id}/rulesets - Read
Get an account entry point ruleset
Fetches the latest version of the account entry point ruleset for a given phase.
GET /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint - Read
List an account entry point ruleset's versions
Fetches the versions of an account entry point ruleset.
GET /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions - Read
Get an account entry point ruleset version
Fetches a specific version of an account entry point ruleset.
GET /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version} - Read
Get an account ruleset
Fetches the latest version of an account ruleset.
GET /accounts/{account_id}/rulesets/{ruleset_id} - Read
List an account ruleset's versions
Fetches the versions of an account ruleset.
GET /accounts/{account_id}/rulesets/{ruleset_id}/versions - Read
Get an account ruleset version
Fetches a specific version of an account ruleset.
GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version} - Read
List an account ruleset version's rules by tag
Fetches the rules of a managed account ruleset version for a given tag.
GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag} - Write
Create an account ruleset
Creates a ruleset at the account level.
POST /accounts/{account_id}/rulesets - Write
Create an account ruleset rule
Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.
POST /accounts/{account_id}/rulesets/{ruleset_id}/rules - Write
Update an account ruleset rule
Updates an existing rule in an account ruleset.
PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id} - Destructive
Update an account entry point ruleset
Updates an account entry point ruleset, creating a new version.
PUT /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint - Destructive
Delete an account ruleset
Deletes all versions of an existing account ruleset.
DELETE /accounts/{account_id}/rulesets/{ruleset_id} - Destructive
Update an account ruleset
Updates an account ruleset, creating a new version.
PUT /accounts/{account_id}/rulesets/{ruleset_id} - Destructive
Delete an account ruleset rule
Deletes an existing rule from an account ruleset.
DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id} - Destructive
Delete an account ruleset version
Deletes an existing version of an account ruleset.
DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}
Web Analytics
- Read
List Web Analytics sites
Lists all Web Analytics sites of an account.
GET /accounts/{account_id}/rum/site_info/list - Read
List Web Analytics site tags
Returns all site tags for an account as an array of site tag strings. This endpoint returns all results without pagination.
GET /accounts/{account_id}/rum/site_info/site_tag/list - Read
Validate a Web Analytics 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.
GET /accounts/{account_id}/rum/site_info/validate/{hostname} - Read
List Web Analytics 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.
GET /accounts/{account_id}/rum/site_info/zone_tag/list - Read
Get a Web Analytics site
Retrieves a Web Analytics site.
GET /accounts/{account_id}/rum/site_info/{site_id} - Read
List rules in Web Analytics ruleset
Lists all the rules in a Web Analytics ruleset.
GET /accounts/{account_id}/rum/v2/{ruleset_id}/rules - Read
Get RUM status for a zone
Retrieves RUM status for a zone.
GET /zones/{zone_id}/settings/rum - Write
Create a Web Analytics site
Creates a new Web Analytics site.
POST /accounts/{account_id}/rum/site_info - Write
Create a Web Analytics rule
Creates a new rule in a Web Analytics ruleset.
POST /accounts/{account_id}/rum/v2/{ruleset_id}/rule - Write
Toggle RUM on/off for a zone
Toggles RUM on/off for an existing zone.
PATCH /zones/{zone_id}/settings/rum - Destructive
Delete a Web Analytics site
Deletes an existing Web Analytics site.
DELETE /accounts/{account_id}/rum/site_info/{site_id} - Destructive
Update a Web Analytics site
Updates an existing Web Analytics site.
PUT /accounts/{account_id}/rum/site_info/{site_id} - Destructive
Delete a Web Analytics rule
Deletes an existing rule from a Web Analytics ruleset.
DELETE /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id} - Destructive
Update a Web Analytics rule
Updates a rule in a Web Analytics ruleset.
PUT /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id} - Destructive
Update Web Analytics rules
Modifies one or more rules in a Web Analytics ruleset with a single request.
POST /accounts/{account_id}/rum/v2/{ruleset_id}/rules
SCIM Groups
- Read
List SCIM Groups
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.
GET /accounts/{account_id}/scim/v2/Groups - Read
Get SCIM Group
Retrieves a single SCIM Group resource by group ID.
GET /accounts/{account_id}/scim/v2/Groups/{group_id} - Write
Create SCIM Group
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).
POST /accounts/{account_id}/scim/v2/Groups - Destructive
Delete SCIM Group
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.
DELETE /accounts/{account_id}/scim/v2/Groups/{group_id} - Destructive
Patch SCIM Group
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.
PATCH /accounts/{account_id}/scim/v2/Groups/{group_id} - Destructive
Replace SCIM Group
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.
PUT /accounts/{account_id}/scim/v2/Groups/{group_id}
SCIM Discovery
- Read
List SCIM Resource Types
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.
GET /accounts/{account_id}/scim/v2/ResourceTypes - Read
Get SCIM Resource Type
Returns a single SCIM resource type by ID (RFC 7643 Section 6). Valid IDs are `User` and `Group`.
GET /accounts/{account_id}/scim/v2/ResourceTypes/{resource_type_id} - Read
List SCIM Schemas
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.
GET /accounts/{account_id}/scim/v2/Schemas - Read
Get SCIM Schema
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`.
GET /accounts/{account_id}/scim/v2/Schemas/{schema_id} - Read
Get SCIM Service Provider Config
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.
GET /accounts/{account_id}/scim/v2/ServiceProviderConfig
SCIM Users
- Read
List SCIM Users
Lists account members as SCIM User resources. Supports optional filtering by `userName` (email) using the SCIM filter syntax (e.g. `userName eq "user@example.com"`). Pagination is controlled via `startIndex` and `count` query parameters per RFC 7644 Section 3.4.2.4.
GET /accounts/{account_id}/scim/v2/Users - Read
Get SCIM User
Retrieves a single account member as a SCIM User resource by user tag.
GET /accounts/{account_id}/scim/v2/Users/{user_id} - Write
Create SCIM User
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.
POST /accounts/{account_id}/scim/v2/Users - Destructive
Delete SCIM User
Deprovisions a SCIM User by removing their membership from this account (RFC 7644 Section 3.6). This does not delete the global Cloudflare user.
DELETE /accounts/{account_id}/scim/v2/Users/{user_id} - Destructive
Patch SCIM User
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`.
PATCH /accounts/{account_id}/scim/v2/Users/{user_id} - Destructive
Replace SCIM User
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`.
PUT /accounts/{account_id}/scim/v2/Users/{user_id}
Secondary DNS (ACL)
- Read
List ACLs
List ACLs.
GET /accounts/{account_id}/secondary_dns/acls - Read
ACL Details
Get ACL.
GET /accounts/{account_id}/secondary_dns/acls/{acl_id} - Write
Create ACL
Create ACL.
POST /accounts/{account_id}/secondary_dns/acls - Destructive
Delete ACL
Delete ACL.
DELETE /accounts/{account_id}/secondary_dns/acls/{acl_id} - Destructive
Update ACL
Modify ACL.
PUT /accounts/{account_id}/secondary_dns/acls/{acl_id}
Secondary DNS (Peer)
- Read
List Peers
List Peers.
GET /accounts/{account_id}/secondary_dns/peers - Read
Peer Details
Get Peer.
GET /accounts/{account_id}/secondary_dns/peers/{peer_id} - Write
Create Peer
Create Peer.
POST /accounts/{account_id}/secondary_dns/peers - Destructive
Delete Peer
Delete Peer.
DELETE /accounts/{account_id}/secondary_dns/peers/{peer_id} - Destructive
Update Peer
Modify Peer.
PUT /accounts/{account_id}/secondary_dns/peers/{peer_id}
Secondary DNS (TSIG)
- Read
List TSIGs
List TSIGs.
GET /accounts/{account_id}/secondary_dns/tsigs - Read
TSIG Details
Get TSIG.
GET /accounts/{account_id}/secondary_dns/tsigs/{tsig_id} - Write
Create TSIG
Create TSIG.
POST /accounts/{account_id}/secondary_dns/tsigs - Destructive
Delete TSIG
Delete TSIG.
DELETE /accounts/{account_id}/secondary_dns/tsigs/{tsig_id} - Destructive
Update TSIG
Modify TSIG.
PUT /accounts/{account_id}/secondary_dns/tsigs/{tsig_id}
Secrets Store
- Read
View secret usage
Lists the number of secrets used in the account.
GET /accounts/{account_id}/secrets_store/quota - Read
List account stores
Lists all the stores in an account.
GET /accounts/{account_id}/secrets_store/stores - Read
Get a store by ID
Returns details of a single store.
GET /accounts/{account_id}/secrets_store/stores/{store_id} - Read
List store secrets
Lists all store secrets.
GET /accounts/{account_id}/secrets_store/stores/{store_id}/secrets - Read
Get a secret by ID
Returns details of a single secret.
GET /accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id} - Write
Create a store
Creates a store in the account.
POST /accounts/{account_id}/secrets_store/stores - Write
Create a secret
Creates a secret in the account.
POST /accounts/{account_id}/secrets_store/stores/{store_id}/secrets - Write
Patch a secret
Updates a single secret.
PATCH /accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id} - Write
Duplicate Secret
Creates a duplicate of the secret, keeping the value.
POST /accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}/duplicate - Destructive
Delete a store
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.
DELETE /accounts/{account_id}/secrets_store/stores/{store_id} - Destructive
Delete secrets
Deletes one or more secrets.
DELETE /accounts/{account_id}/secrets_store/stores/{store_id}/secrets - Destructive
Delete a secret
Deletes a single secret.
DELETE /accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}
Security Center Audit Log
- Read
Retrieves Account Audit Log
Lists audit log entries for all Security Center insights in the account, showing changes to insight status and classification.
GET /accounts/{account_id}/security-center/insights/audit-log - Read
Retrieves Issue Audit Log
Lists audit log entries for a specific Security Center insight, showing changes to its status and classification over time.
GET /accounts/{account_id}/security-center/insights/{issue_id}/audit-log - Read
Retrieves Zone Audit Log
Lists audit log entries for all Security Center insights in a specific zone, showing changes to insight status and classification.
GET /zones/{zone_id}/security-center/insights/audit-log - Read
Retrieves Zone 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.
GET /zones/{zone_id}/security-center/insights/{issue_id}/audit-log
Security Center Scans
- Read
Get Recent 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.
GET /accounts/{account_id}/security-center/insights/scans - Read
Get Recent 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.
GET /zones/{zone_id}/security-center/insights/scans - Write
Start On-Demand 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.
POST /accounts/{account_id}/security-center/insights/scans - Write
Start On-Demand 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).
POST /zones/{zone_id}/security-center/insights/scans
Security Center Partners
- Read
Retrieves Partner Integration 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.
GET /accounts/{account_id}/security-center/partners/{partner}/settings - Read
Lists Partner-Discovered 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.
GET /accounts/{account_id}/security-center/partners/{partner}/shadow-zones - Read
Lists Hosts in a Partner-Discovered Shadow Zone
Lists hosts discovered beneath a shadow-zone domain. This endpoint is available only to premium accounts and supports JSON and CSV output.
GET /accounts/{account_id}/security-center/partners/{partner}/shadow-zones/{domain}/hosts - Read
Lists Partner-Discovered Shadow Hosts for a Zone
Lists partner-discovered hosts beneath the zone that are not in the account.
GET /zones/{zone_id}/security-center/partners/{partner}/shadow-hosts - Write
Updates Partner Integration 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.
POST /accounts/{account_id}/security-center/partners/{partner}/settings
Account Settings
- Read
List Image Resizing configurations for account
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.
GET /accounts/{account_id}/settings/transformations - Read
Get Unique Transformations billing setting
Retrieves the Unique Transformations billing configuration for an account. When enabled, billing data is directed to the Transformations pipeline.
GET /accounts/{account_id}/settings/ut-billing - Write
Change Unique Transformations 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.
PATCH /accounts/{account_id}/settings/ut-billing
Resource Sharing
R2 Super Slurper
- Read
List jobs
Lists all R2 Super Slurper migration jobs for the account with their status.
GET /accounts/{account_id}/slurper/jobs - Read
Get job details
Retrieves detailed status and configuration for a specific R2 Super Slurper migration job.
GET /accounts/{account_id}/slurper/jobs/{job_id} - Read
Get job logs
Gets log entries for an R2 Super Slurper migration job, showing migration status changes, errors, etc.
GET /accounts/{account_id}/slurper/jobs/{job_id}/logs - Read
Get job progress
Retrieves current progress metrics for an R2 Super Slurper migration job
GET /accounts/{account_id}/slurper/jobs/{job_id}/progress - Write
Create a job
Creates a new R2 Super Slurper migration job to transfer objects from a source bucket (e.g. S3, GCS, R2) to R2.
POST /accounts/{account_id}/slurper/jobs - Destructive
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.
PUT /accounts/{account_id}/slurper/jobs/abortAll - Destructive
Delete a job
Deletes a completed, aborted, or errored R2 Super Slurper migration job. Active jobs cannot be deleted.
DELETE /accounts/{account_id}/slurper/jobs/{job_id} - Destructive
Abort a 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.
PUT /accounts/{account_id}/slurper/jobs/{job_id}/abort - Destructive
Pause a job
Pauses a running R2 Super Slurper migration job. The job can be resumed later to continue transferring.
PUT /accounts/{account_id}/slurper/jobs/{job_id}/pause - Destructive
Resume a job
Resumes a paused R2 Super Slurper migration job, continuing the transfer from where it stopped.
PUT /accounts/{account_id}/slurper/jobs/{job_id}/resume - Destructive
Check source connectivity
Check whether tokens are valid against the source bucket
PUT /accounts/{account_id}/slurper/source/connectivity-precheck - Destructive
Check target connectivity
Check whether tokens are valid against the target bucket
PUT /accounts/{account_id}/slurper/target/connectivity-precheck
SSO
- Read
Get all SSO connectors
Lists all SSO connectors configured for the account.
GET /accounts/{account_id}/sso_connectors - Read
Get single SSO connector
Retrieves details for a specific SSO connector.
GET /accounts/{account_id}/sso_connectors/{sso_connector_id} - Write
Initialize new SSO connector
Creates a new SSO connector for logging into Cloudflare through an identity provider.
POST /accounts/{account_id}/sso_connectors - Write
Update SSO connector state
Updates the state or configuration of an SSO connector.
PATCH /accounts/{account_id}/sso_connectors/{sso_connector_id} - Write
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.
POST /accounts/{account_id}/sso_connectors/{sso_connector_id}/begin_verification - Destructive
Delete SSO connector
Deletes an SSO connector from the account.
DELETE /accounts/{account_id}/sso_connectors/{sso_connector_id}
Workers KV Namespace
- Read
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.
GET /accounts/{account_id}/storage/kv/namespaces - Read
Get a namespace
Returns the Workers KV namespace for the specified account and namespace ID.
GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id} - Read
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.
POST /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/get - Read
List keys in a namespace
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.
GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys - Read
Get a key's metadata
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.
GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name} - Read
Get a key's value
Returns the value stored under the specified key in the Workers KV namespace as raw bytes. Use URL-encoding for special characters (for example, `:`, `!`, `%`) in the key name when constructing the request URL. If the key-value pair expires, the `expiration` response header contains its expiration time in seconds since the UNIX epoch.
GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name} - Write
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.
POST /accounts/{account_id}/storage/kv/namespaces - Destructive
Delete a namespace
Deletes the specified Workers KV namespace and its stored key-value pairs from the account.
DELETE /accounts/{account_id}/storage/kv/namespaces/{namespace_id} - Destructive
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.
PUT /accounts/{account_id}/storage/kv/namespaces/{namespace_id} - Destructive
Delete multiple key-value pairs (deprecated)
Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed.
DELETE /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk - Destructive
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.
PUT /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk - Destructive
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.
POST /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete - Destructive
Delete a 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.
DELETE /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name} - Destructive
Write a key-value pair with optional metadata
Writes a value under the specified key in the Workers KV namespace, creating the key-value pair or replacing its existing value, expiration, and metadata. Send the value as an `application/octet-stream` request body, or use `multipart/form-data` with a `value` part and an optional JSON `metadata` part. Use URL-encoding for special characters (for example, `:`, `!`, `%`) in the key name when constructing the request URL. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will not expire. If both are set, `expiration_ttl` takes precedence.
PUT /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}
Stream Videos
- Read
List videos
Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.
GET /accounts/{account_id}/stream - Read
Storage use
Returns information about an account's storage use.
GET /accounts/{account_id}/stream/storage-usage - Read
Retrieve video details
Fetches details for a single video.
GET /accounts/{account_id}/stream/{identifier} - Read
Deprecated: Retrieve legacy 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.
GET /accounts/{account_id}/stream/{identifier}/embed - Write
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.
POST /accounts/{account_id}/stream - Write
Upload videos from a URL
Uploads a video to Stream from a provided URL.
POST /accounts/{account_id}/stream/copy - Write
Upload videos via direct upload URLs
Creates a direct upload endpoint that allows an end-user to upload a video without an API key.
POST /accounts/{account_id}/stream/direct_upload - Write
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.
POST /accounts/{account_id}/stream/{identifier}/token - Destructive
Delete video
Deletes a video and its copies from Cloudflare Stream.
DELETE /accounts/{account_id}/stream/{identifier} - Destructive
Edit video details
Edit details for a single video.
POST /accounts/{account_id}/stream/{identifier}
Stream Video Clipping
- Write
Clip videos given a start and end time
Clips a video based on the specified start and end times provided in seconds.
POST /accounts/{account_id}/stream/clip
Stream Signing Keys
- Read
List signing keys
Lists the video ID and creation date and time when a signing key was created.
GET /accounts/{account_id}/stream/keys - Write
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.
POST /accounts/{account_id}/stream/keys - Destructive
Delete signing keys
Deletes signing keys and revokes all signed URLs generated with the key.
DELETE /accounts/{account_id}/stream/keys/{identifier}
Stream Live Inputs
- Read
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.
GET /accounts/{account_id}/stream/live_inputs - Read
Retrieve a live input
Retrieves details of an existing live input.
GET /accounts/{account_id}/stream/live_inputs/{live_input_identifier} - Read
List all outputs associated with a specified live input
Retrieves all outputs associated with a specified live input.
GET /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs - Write
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.
POST /accounts/{account_id}/stream/live_inputs - Write
Disable a live input
Prevents a live input from being streamed to and terminates any active broadcasts until re-enabled.
POST /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/disable - Write
Enable a live input
Allows a disabled live input to start receiving broadcasts again.
POST /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/enable - Write
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.
POST /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs - Destructive
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.
DELETE /accounts/{account_id}/stream/live_inputs/{live_input_identifier} - Destructive
Update a live input
Updates a specified live input.
PUT /accounts/{account_id}/stream/live_inputs/{live_input_identifier} - Destructive
Delete an output
Deletes an output and removes it from the associated live input.
DELETE /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier} - Destructive
Update an output
Updates the state of an output.
PUT /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier} - Destructive
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.
POST /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/rotate_keys
Stream Watermark Profile
- Read
List watermark profiles
Lists all watermark profiles for an account.
GET /accounts/{account_id}/stream/watermarks - Read
Watermark profile details
Retrieves details for a single watermark profile.
GET /accounts/{account_id}/stream/watermarks/{identifier} - Write
Create watermark profiles via basic upload
Creates watermark profiles using a single `HTTP POST multipart/form-data` request.
POST /accounts/{account_id}/stream/watermarks - Destructive
Delete watermark profiles
Deletes a watermark profile.
DELETE /accounts/{account_id}/stream/watermarks/{identifier}
Stream Webhook
- Read
View webhook
Retrieve current on-demand webhook information.
GET /accounts/{account_id}/stream/webhook - Destructive
Delete webhooks
Deletes the on-demand video webhook.
DELETE /accounts/{account_id}/stream/webhook - Destructive
Create VOD webhooks
Create a webhook for notifications about on-demand video uploads.
PUT /accounts/{account_id}/stream/webhook
Stream Audio Tracks
- Read
List additional audio tracks on a video
Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload.
GET /accounts/{account_id}/stream/{identifier}/audio - Write
Add audio tracks to a video
Adds an additional audio track to a video using the provided audio track URL.
POST /accounts/{account_id}/stream/{identifier}/audio/copy - Write
Edit additional audio tracks on a video
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`.
PATCH /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier} - Destructive
Delete additional audio tracks on a video
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.
DELETE /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}
Stream Subtitles/Captions
- Read
List captions or subtitles
Lists the available captions or subtitles for a specific video.
GET /accounts/{account_id}/stream/{identifier}/captions - Read
List captions or subtitles for a provided language
Lists the captions or subtitles for provided language.
GET /accounts/{account_id}/stream/{identifier}/captions/{language} - Read
Return WebVTT captions for a provided language
Return WebVTT captions for a provided language.
GET /accounts/{account_id}/stream/{identifier}/captions/{language}/vtt - Write
Generate captions or subtitles for a provided language via AI
Generate captions or subtitles for provided language via AI.
POST /accounts/{account_id}/stream/{identifier}/captions/{language}/generate - Destructive
Delete captions or subtitles
Removes the captions or subtitles from a video.
DELETE /accounts/{account_id}/stream/{identifier}/captions/{language} - Destructive
Upload captions or subtitles
Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.
PUT /accounts/{account_id}/stream/{identifier}/captions/{language}
Stream MP4 Downloads
- Read
List downloads
Lists the downloads created for a video.
GET /accounts/{account_id}/stream/{identifier}/downloads - Write
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`.
POST /accounts/{account_id}/stream/{identifier}/downloads - Write
Create download
Creates a download for a video of specified type. For backwards-compatibility, POST requests to /downloads will enable the default download.
POST /accounts/{account_id}/stream/{identifier}/downloads/{download_type} - Destructive
Delete downloads
Delete the downloads for a video. Use `/downloads/{download_type}` instead for type-specific downloads. Available types are `default` and `audio`.
DELETE /accounts/{account_id}/stream/{identifier}/downloads - Destructive
Delete download
Delete specific type of download. For backwards-compatibility, DELETE requests to /downloads will delete the default download.
DELETE /accounts/{account_id}/stream/{identifier}/downloads/{download_type}
Resource Tagging
- Read
Get tags for an account-level resource
Retrieves tags for a specific account-level resource.
GET /accounts/{account_id}/tags - Read
List tag keys
Lists all distinct tag keys used across resources in an account.
GET /accounts/{account_id}/tags/keys - Read
List tagged resources
Lists all tagged resources for an account.
GET /accounts/{account_id}/tags/resources - Read
List tag key summary
Lists all distinct tag keys and their distinct values across resources in an account.
GET /accounts/{account_id}/tags/summary - Read
List tag values
Lists all distinct values for a given tag key, optionally filtered by resource type.
GET /accounts/{account_id}/tags/values/{tag_key} - Read
Get tags for a zone-level resource
Retrieves tags for a specific zone-level resource.
GET /zones/{zone_id}/tags - Destructive
Delete tags from an account-level resource
Removes all tags from a specific account-level resource.
DELETE /accounts/{account_id}/tags - Destructive
Set tags for an account-level resource
Creates or updates tags for a specific account-level resource. Replaces all existing tags for the resource.
PUT /accounts/{account_id}/tags - Destructive
Delete tags from a zone-level resource
Removes all tags from a specific zone-level resource.
DELETE /zones/{zone_id}/tags - Destructive
Set tags for a zone-level resource
Creates or updates tags for a specific zone-level resource. Replaces all existing tags for the resource.
PUT /zones/{zone_id}/tags
Tunnel Routing
- Read
List tunnel routes
Lists and filters private network routes in an account.
GET /accounts/{account_id}/teamnet/routes - Read
Get tunnel route by IP
Fetches routes that contain the given IP address.
GET /accounts/{account_id}/teamnet/routes/ip/{ip} - Read
Get tunnel route
Get a private network route in an account.
GET /accounts/{account_id}/teamnet/routes/{route_id} - Write
Create a tunnel route
Routes a private network through a Cloudflare Tunnel.
POST /accounts/{account_id}/teamnet/routes - Write
Update a tunnel route (CIDR Endpoint) (deprecated)
Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.
PATCH /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded} - Write
Create a tunnel route (CIDR Endpoint) (deprecated)
Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format.
POST /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded} - Write
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.
PATCH /accounts/{account_id}/teamnet/routes/{route_id} - Destructive
Delete a tunnel route (CIDR Endpoint) (deprecated)
Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.
DELETE /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded} - Destructive
Delete a tunnel route
Deletes a private network route from an account.
DELETE /accounts/{account_id}/teamnet/routes/{route_id}
Tunnel Virtual Network
- Read
List virtual networks
Lists and filters virtual networks in an account.
GET /accounts/{account_id}/teamnet/virtual_networks - Read
Get a virtual network
Get a virtual network.
GET /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id} - Write
Create a virtual network
Adds a new virtual network to an account.
POST /accounts/{account_id}/teamnet/virtual_networks - Write
Update a virtual network
Updates an existing virtual network.
PATCH /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id} - Destructive
Delete a virtual network
Deletes an existing virtual network.
DELETE /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}
Account Owned API Tokens
- Read
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.
GET /accounts/{account_id}/tokens - Read
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.
GET /accounts/{account_id}/tokens/permission_groups - Read
Verify Token
Test whether a token works.
GET /accounts/{account_id}/tokens/verify - Read
Token Details
Get information about a specific Account Owned API token.
GET /accounts/{account_id}/tokens/{token_id} - Write
Create Token
Create a new Account Owned API token.
POST /accounts/{account_id}/tokens - Destructive
Delete Token
Destroy an Account Owned API token.
DELETE /accounts/{account_id}/tokens/{token_id} - Destructive
Update Token
Update an existing token.
PUT /accounts/{account_id}/tokens/{token_id} - Destructive
Roll Token
Roll the Account Owned API token secret.
PUT /accounts/{account_id}/tokens/{token_id}/value
Workflows
- Read
Get script triggers
Returns the event trigger declarations owned by a Worker script.
GET /accounts/{account_id}/triggers/{script_name} - Read
List all Workflows
Lists all workflows configured for the account.
GET /accounts/{account_id}/workflows - Read
List concurrency keys
Lists the account-scoped concurrency keys.
GET /accounts/{account_id}/workflows/concurrency - Read
Get concurrency key details
Retrieves a concurrency key and the workflows whose latest version references it.
GET /accounts/{account_id}/workflows/concurrency/{key_id} - Read
Get account settings
Retrieves account-level Workflows settings, such as the default instance retention.
GET /accounts/{account_id}/workflows/settings - Read
Get Workflow details
Retrieves configuration and metadata for a specific workflow.
GET /accounts/{account_id}/workflows/{workflow_name} - Read
List of workflow instances
Lists all instances of a workflow with their execution status.
GET /accounts/{account_id}/workflows/{workflow_name}/instances - Read
Get status of the job responsible for terminate all instances of a workflow
Gets the status of a bulk workflow instance termination job.
GET /accounts/{account_id}/workflows/{workflow_name}/instances/terminate - Read
Get logs and status from instance
Retrieves logs and execution status for a specific workflow instance.
GET /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id} - Read
Get full step output from instance
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.
GET /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/step - Read
Create a workflow instance event subscription token
Creates a short-lived token for connecting to the workflow instance event WebSocket.
GET /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/subscribe/token - Read
List deployed Workflow versions
Lists all deployed versions of a workflow.
GET /accounts/{account_id}/workflows/{workflow_name}/versions - Read
Get Workflow version details
Retrieves details for a specific deployed workflow version.
GET /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id} - Read
Get Workflow version dag
Retrieves the directed acyclic graph (DAG) representation of a workflow version.
GET /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/dag - Read
Get Workflow version graph
Retrieves the graph visualization of a workflow version.
GET /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/graph - Write
Add script triggers
Adds event trigger declarations without removing existing declarations owned by the script.
PATCH /accounts/{account_id}/triggers/{script_name} - Write
Create a concurrency key
Creates an account-scoped concurrency key. Limits count steps still in flight from a previously deleted key of the same name.
POST /accounts/{account_id}/workflows/concurrency - Write
Update a concurrency key
Updates the limit of a concurrency key. Applies to instances that start after the change.
PATCH /accounts/{account_id}/workflows/concurrency/{key_id} - Write
Update account settings
Updates only the account-level Workflows settings fields present in the request body.
PATCH /accounts/{account_id}/workflows/settings - Write
Create a new workflow instance
Creates a new instance of a workflow, starting its execution.
POST /accounts/{account_id}/workflows/{workflow_name}/instances - Write
Batch create new Workflow instances
Creates multiple workflow instances in a single batch operation.
POST /accounts/{account_id}/workflows/{workflow_name}/instances/batch - Write
Batch terminate instances of a workflow
Performs a batch termination of multiple workflow instances.
POST /accounts/{account_id}/workflows/{workflow_name}/instances/batch/terminate - Write
Send event to instance
Sends an event to a running workflow instance to trigger state transitions.
POST /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type} - Write
Change status of instance
Changes the execution status of a workflow instance (e.g., pause, resume, terminate).
PATCH /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status - Destructive
Delete script triggers
Deletes all event trigger declarations owned by a Worker script.
DELETE /accounts/{account_id}/triggers/{script_name} - Destructive
Replace script triggers
Replaces all event trigger declarations owned by a Worker script.
PUT /accounts/{account_id}/triggers/{script_name} - Destructive
Delete a 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.
DELETE /accounts/{account_id}/workflows/concurrency/{key_id} - Destructive
Deletes a 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.
DELETE /accounts/{account_id}/workflows/{workflow_name} - Destructive
Create/modify Workflow
Creates a new workflow or updates an existing workflow definition.
PUT /accounts/{account_id}/workflows/{workflow_name} - Destructive
Batch delete instances of a workflow
Deletes multiple workflow instances in a single batch operation.
POST /accounts/{account_id}/workflows/{workflow_name}/instances/batch/delete - Destructive
Delete a workflow instance
Deletes a workflow instance and its stored state.
DELETE /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}
URL Scanner (Deprecated)
- Read
Get raw response (deprecated)
Returns the plain response of the network request.
GET /accounts/{account_id}/urlscanner/response/{response_id} - Read
Search URL scans (deprecated)
Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path. <br/> A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by `scanId`. Please take into account that older scans may be removed from the search index at an unspecified time.
GET /accounts/{account_id}/urlscanner/scan - Read
Get URL scan (deprecated)
Get URL scan by uuid
GET /accounts/{account_id}/urlscanner/scan/{scan_id} - Read
Get URL scan's HAR (deprecated)
Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.
GET /accounts/{account_id}/urlscanner/scan/{scan_id}/har - Read
Get screenshot (deprecated)
Get scan's screenshot by resolution (desktop/mobile/tablet).
GET /accounts/{account_id}/urlscanner/scan/{scan_id}/screenshot - Write
Create URL Scan (deprecated)
Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.
POST /accounts/{account_id}/urlscanner/scan
URL Scanner
- Read
Get URL scan's DOM
Returns a plain text response, with the scan's DOM content as rendered by Chrome.
GET /accounts/{account_id}/urlscanner/v2/dom/{scan_id} - Read
Get URL scan's HAR
Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.
GET /accounts/{account_id}/urlscanner/v2/har/{scan_id} - Read
Get raw response
Returns the raw response of the network request. Find the `response_id` in the `data.requests.response.hash`.
GET /accounts/{account_id}/urlscanner/v2/responses/{response_id} - Read
Get URL scan
Get URL scan by uuid
GET /accounts/{account_id}/urlscanner/v2/result/{scan_id} - Read
Get screenshot
Get scan's screenshot by resolution (desktop/mobile/tablet).
GET /accounts/{account_id}/urlscanner/v2/screenshots/{scan_id}.png - Read
Search URL scans
Use a subset of ElasticSearch Query syntax to filter scans. Some example queries:<br/> <br/>- 'path:"/bundles/jquery.js"': Searches for scans who requested resources with the given path.<br/>- 'page.asn:AS24940 AND hash:xxx': Websites hosted in AS24940 where a resource with the given hash was downloaded.<br/>- 'page.domain:microsoft* AND verdicts.malicious:true AND NOT page.domain:microsoft.com': malicious scans whose hostname starts with "microsoft".<br/>- 'apikey:me AND date:[2025-01 TO 2025-02]': my scans from 2025 January to 2025 February.
GET /accounts/{account_id}/urlscanner/v2/search - Write
Bulk create URL Scans
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.
POST /accounts/{account_id}/urlscanner/v2/bulk - Write
Create URL Scan
Submit a URL to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.
POST /accounts/{account_id}/urlscanner/v2/scan
Vectorize Beta (Deprecated)
- Read
List Vectorize Indexes (Deprecated) (deprecated)
Returns a list of Vectorize Indexes
GET /accounts/{account_id}/vectorize/indexes - Read
Get Vectorize Index (Deprecated) (deprecated)
Returns the specified Vectorize Index.
GET /accounts/{account_id}/vectorize/indexes/{index_name} - Write
Create Vectorize Index (Deprecated) (deprecated)
Creates and returns a new Vectorize Index.
POST /accounts/{account_id}/vectorize/indexes - Write
Get Vectors By Identifier (Deprecated) (deprecated)
Get a set of vectors from an index by their vector identifiers.
POST /accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids - Write
Insert Vectors (Deprecated) (deprecated)
Inserts vectors into the specified index and returns the count of the vectors successfully inserted.
POST /accounts/{account_id}/vectorize/indexes/{index_name}/insert - Write
Query Vectors (Deprecated) (deprecated)
Finds vectors closest to a given vector in an index.
POST /accounts/{account_id}/vectorize/indexes/{index_name}/query - Write
Upsert Vectors (Deprecated) (deprecated)
Upserts vectors into the specified index, creating them if they do not exist and returns the count of values and ids successfully inserted.
POST /accounts/{account_id}/vectorize/indexes/{index_name}/upsert - Destructive
Delete Vectorize Index (Deprecated) (deprecated)
Deletes the specified Vectorize Index.
DELETE /accounts/{account_id}/vectorize/indexes/{index_name} - Destructive
Update Vectorize Index (Deprecated) (deprecated)
Updates and returns the specified Vectorize Index.
PUT /accounts/{account_id}/vectorize/indexes/{index_name} - Destructive
Delete Vectors By Identifier (Deprecated) (deprecated)
Delete a set of vectors from an index by their vector identifiers.
POST /accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids
Vectorize
- Read
List Vectorize Indexes
Returns a list of Vectorize Indexes
GET /accounts/{account_id}/vectorize/v2/indexes - Read
Get Vectorize Index
Returns the specified Vectorize Index.
GET /accounts/{account_id}/vectorize/v2/indexes/{index_name} - Read
Get Vectors By Identifier
Get a set of vectors from an index by their vector identifiers.
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids - Read
Get Vectorize Index Info
Get information about a vectorize index.
GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/info - Read
List Vectors
Returns a paginated list of vector identifiers from the specified index.
GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/list - Read
List Metadata Indexes
List Metadata Indexes for the specified Vectorize Index.
GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list - Read
Query Vectors
Finds vectors closest to a given vector in an index.
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/query - Write
Create Vectorize Index
Creates and returns a new Vectorize Index.
POST /accounts/{account_id}/vectorize/v2/indexes - Write
Insert Vectors
Inserts vectors into the specified index and returns a mutation id corresponding to the vectors enqueued for insertion.
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert - Write
Create Metadata Index
Enable metadata filtering based on metadata property. Limited to 10 properties.
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create - Write
Upsert Vectors
Upserts vectors into the specified index, creating them if they do not exist and returns a mutation id corresponding to the vectors enqueued for upsertion.
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert - Destructive
Delete Vectorize Index
Deletes the specified Vectorize Index.
DELETE /accounts/{account_id}/vectorize/v2/indexes/{index_name} - Destructive
Delete Vectors By Identifier
Delete a set of vectors from an index by their vector identifiers.
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids - Destructive
Delete Metadata Index
Allow Vectorize to delete the specified metadata index.
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete
Credential Sets
- Read
List credential sets
Returns all credential sets for the account.
GET /accounts/{account_id}/vuln_scanner/credential_sets - Read
Get credential set
Returns a single credential set by ID.
GET /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id} - Write
Create credential set
Creates a new credential set.
POST /accounts/{account_id}/vuln_scanner/credential_sets - Write
Edit credential set
Updates a credential set with only the provided fields; omitted fields remain unchanged.
PATCH /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id} - Destructive
Delete credential set
Deletes a credential set and all of its credentials.
DELETE /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id} - Destructive
Update credential set
Replaces a credential set. All fields must be provided.
PUT /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}
Credentials
- Read
List credentials
Returns all credentials within a credential set.
GET /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials - Read
Get credential
Returns a single credential by ID.
GET /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id} - Write
Create credential
Creates a new credential within a credential set.
POST /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials - Write
Edit credential
Updates a credential with only the provided fields; omitted fields remain unchanged.
PATCH /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id} - Destructive
Delete credential
Deletes a credential.
DELETE /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id} - Destructive
Update credential
Replaces a credential. All fields must be provided.
PUT /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}
Target Environments
- Read
List target environments
Returns all target environments for the account.
GET /accounts/{account_id}/vuln_scanner/target_environments - Read
Get target environment
Returns a single target environment by ID.
GET /accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id} - Write
Create target environment
Creates a new target environment for the account.
POST /accounts/{account_id}/vuln_scanner/target_environments - Destructive
Delete target environment
Removes a target environment.
DELETE /accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id} - Destructive
Edit target environment
Updates a target environment with only the provided fields; omitted fields remain unchanged.
PATCH /accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id} - Destructive
Update target environment
Replaces a target environment. All fields must be provided.
PUT /accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id}
Waiting Room
- Read
List waiting rooms for account
Lists waiting rooms for account.
GET /accounts/{account_id}/waiting_rooms - Read
List waiting rooms for zone
Lists waiting rooms for zone.
GET /zones/{zone_id}/waiting_rooms - Read
Get zone-level Waiting Room settings
Get zone-level Waiting Room settings.
GET /zones/{zone_id}/waiting_rooms/settings - Read
Waiting room details
Fetches a single configured waiting room.
GET /zones/{zone_id}/waiting_rooms/{waiting_room_id} - Read
List events
Lists events for a waiting room.
GET /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events - Read
Event details
Fetches a single configured event for a waiting room.
GET /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id} - Read
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.
GET /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}/details - Read
List Waiting Room Rules
Lists rules for a waiting room.
GET /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules - Read
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.
GET /zones/{zone_id}/waiting_rooms/{waiting_room_id}/status - Write
Create waiting room
Creates a new waiting room.
POST /zones/{zone_id}/waiting_rooms - Write
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**). For example, you can make a request to `http://waitingrooms.dev/preview/<uuid>?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true` 6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes. For example, you can make a request to `http://waitingrooms.dev/preview/<uuid>?waitTime=50` to configure the estimated wait time as 50 minutes.
POST /zones/{zone_id}/waiting_rooms/preview - Write
Patch zone-level Waiting Room settings
Patch zone-level Waiting Room settings.
PATCH /zones/{zone_id}/waiting_rooms/settings - Write
Patch waiting room
Patches a configured waiting room.
PATCH /zones/{zone_id}/waiting_rooms/{waiting_room_id} - Write
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.
POST /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events - Write
Patch event
Patches a configured event for a waiting room.
PATCH /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id} - Write
Create Waiting Room Rule
Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.
POST /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules - Write
Patch Waiting Room Rule
Patches a rule for a waiting room.
PATCH /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id} - Destructive
Update zone-level Waiting Room settings
Replace zone-level Waiting Room settings.
PUT /zones/{zone_id}/waiting_rooms/settings - Destructive
Delete waiting room
Deletes a waiting room.
DELETE /zones/{zone_id}/waiting_rooms/{waiting_room_id} - Destructive
Update waiting room
Updates a configured waiting room.
PUT /zones/{zone_id}/waiting_rooms/{waiting_room_id} - Destructive
Delete event
Deletes an event for a waiting room.
DELETE /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id} - Destructive
Update event
Updates a configured event for a waiting room.
PUT /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id} - Destructive
Replace Waiting Room Rules
Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.
PUT /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules - Destructive
Delete Waiting Room Rule
Deletes a rule for a waiting room.
DELETE /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
Workers Account Settings
- Read
Fetch Workers Account Settings
Fetches Workers account settings for an account.
GET /accounts/{account_id}/workers/account-settings - Destructive
Configure Workers Account Settings
Configure Workers account settings for an account.
PUT /accounts/{account_id}/workers/account-settings
Worker Script
- Read
List Worker Scripts
Fetch a list of uploaded Worker scripts.
GET /accounts/{account_id}/workers/scripts - Read
Search Worker Scripts
Search for Worker scripts in an account.
GET /accounts/{account_id}/workers/scripts-search - Read
Download Worker Script
Fetch raw content for a Worker script. Note this is the original script content, not JSON encoded.
GET /accounts/{account_id}/workers/scripts/{script_name} - Read
Get Worker Script Content
Fetch Worker script content only.
GET /accounts/{account_id}/workers/scripts/{script_name}/content/v2 - Read
Get Worker Script Settings
Get Worker script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Includes Logpush and Tail Consumers.
GET /accounts/{account_id}/workers/scripts/{script_name}/script-settings - Read
List secrets bound to a Worker script
List the names of secrets bound to a Worker script.
GET /accounts/{account_id}/workers/scripts/{script_name}/secrets - Read
Get a secret binding
Get a given secret binding (value omitted) on a Worker script.
GET /accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name} - Read
Get Worker Script and Version Settings
Get Worker script metadata and config, such as bindings or usage model.
GET /accounts/{account_id}/workers/scripts/{script_name}/settings - Read
Get Worker Script Subdomain
Get whether a Worker script is available on the workers.dev subdomain.
GET /accounts/{account_id}/workers/scripts/{script_name}/subdomain - Read
Get Worker Script Usage Model
Fetches the usage model for a Worker script.
GET /accounts/{account_id}/workers/scripts/{script_name}/usage-model - Write
Upload Worker Assets
Upload Worker assets ahead of creating a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.
POST /accounts/{account_id}/workers/assets/upload - Write
Create Worker 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/.
POST /accounts/{account_id}/workers/scripts/{script_name}/assets-upload-session - Write
Patch Worker Script Settings
Patch Worker script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Including but not limited to Logpush and Tail Consumers.
PATCH /accounts/{account_id}/workers/scripts/{script_name}/script-settings - Write
Update Worker Script Subdomain
Enable or disable a Worker script on the workers.dev subdomain.
POST /accounts/{account_id}/workers/scripts/{script_name}/subdomain - Destructive
Delete Worker
Delete your worker. This call has no response body on a successful delete.
DELETE /accounts/{account_id}/workers/scripts/{script_name} - Destructive
Upload Worker Module
Upload a worker module. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.
PUT /accounts/{account_id}/workers/scripts/{script_name} - Destructive
Replace Worker Script Content
Replace Worker script content without touching config or metadata.
PUT /accounts/{account_id}/workers/scripts/{script_name}/content - Destructive
Add a secret to a Worker script
Add a secret to a Worker script by creating a new version with that secret. When changing more than one secret at a time, prefer the "Patch multiple script secrets" API instead of changing many secrets individually.
PUT /accounts/{account_id}/workers/scripts/{script_name}/secrets - Destructive
Patch multiple Worker script secrets
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. Usage: - To create or update a secret, set its value to a secret object. - To delete a secret, set its value to `null`. - Secrets not included in the request are left unchanged.
PATCH /accounts/{account_id}/workers/scripts/{script_name}/secrets-bulk - Destructive
Delete Worker script secret
Remove a secret from a Worker script by creating a new version without that secret. When changing more than one secret at a time, prefer the "Patch multiple script secrets" API instead of changing many secrets individually.
DELETE /accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name} - Destructive
Patch Worker Script and Version Settings
Patch Worker script metadata or config, such as bindings or usage model.
PATCH /accounts/{account_id}/workers/scripts/{script_name}/settings - Destructive
Delete Worker Script Subdomain
Disable all workers.dev subdomains for a Worker script.
DELETE /accounts/{account_id}/workers/scripts/{script_name}/subdomain - Destructive
Replace Worker Script Usage Model
Replaces the usage model for a Worker script. Requires a Workers Paid subscription.
PUT /accounts/{account_id}/workers/scripts/{script_name}/usage-model
Workers for Platforms
- Read
List Workers for Platforms Dispatch Namespaces
Fetch a list of Workers for Platforms dispatch namespaces.
GET /accounts/{account_id}/workers/dispatch/namespaces - Read
Get Workers for Platforms Dispatch Namespace
Get a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace} - Read
List Workers for Platforms Scripts
Fetch a list of scripts uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts - Read
Get Workers for Platforms Script details
Fetch information about a script uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name} - Read
Get Workers for Platforms Script Bindings
Fetch bindings from a script uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings - Read
Get Workers for Platforms Script Content
Fetch content from a script uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content - Read
List Workers for Platforms Script Secrets
List secrets bound to a script uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets - Read
Get Workers for Platforms Script Secret
Get a given secret binding (value omitted) on a script uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets/{secret_name} - Read
Get Workers for Platforms Script Settings
Get settings for a script uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings - Read
List Workers for Platforms Script Tags
Fetch tags from a script uploaded to a Workers for Platforms dispatch namespace.
GET /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags - Write
Create Workers for Platforms Dispatch Namespace
Create a new Workers for Platforms dispatch namespace.
POST /accounts/{account_id}/workers/dispatch/namespaces - Write
Patch Workers for Platforms Dispatch Namespace
Patch a Workers for Platforms dispatch namespace. Omitted fields are left unchanged.
PATCH /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace} - Write
Create Workers for Platforms 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/.
POST /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/assets-upload-session - Write
Update Workers for Platforms 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 requires an `api-version` on or after `2026-10-01`.
PATCH /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag} - Destructive
Delete Workers for Platforms Dispatch Namespace
Delete a Workers for Platforms dispatch namespace.
DELETE /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace} - Destructive
Update Workers for Platforms Dispatch Namespace
Update a Workers for Platforms dispatch namespace.
PUT /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace} - Destructive
Delete Workers for Platforms Scripts
Delete multiple scripts from a Workers for Platforms dispatch namespace based on optional tag filters.
DELETE /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts - Destructive
Delete Workers for Platforms Script
Delete a script from a Workers for Platforms dispatch namespace. This call has no response body on a successful delete.
DELETE /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name} - Destructive
Upload Workers for Platforms Script Module
Upload a Workers for Platforms script module to a dispatch namespace. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.
PUT /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name} - Destructive
Replace Workers for Platforms Script Content
Replace content for a script uploaded to a Workers for Platforms dispatch namespace.
PUT /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content - Destructive
Add a secret to a Workers for Platforms script
Add a secret to a Workers for Platforms script by creating a new version with that secret. When changing more than one secret at a time, prefer the "Patch multiple script secrets" API instead of changing many secrets individually.
PUT /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets - Destructive
Patch multiple Workers for Platforms script secrets
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. Usage: - To create or update a secret, set its value to a secret object. - To delete a secret, set its value to `null`. - Secrets not included in the request are left unchanged.
PATCH /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets-bulk - Destructive
Delete Workers for Platforms script secret
Remove a secret from a Workers for Platforms script by creating a new version without that secret. When changing more than one secret at a time, prefer the "Patch multiple script secrets" API instead of changing many secrets individually.
DELETE /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets/{secret_name} - Destructive
Patch Workers for Platforms Script Settings
Patch metadata for a script uploaded to a Workers for Platforms dispatch namespace, such as bindings.
PATCH /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings - Destructive
Replace Workers for Platforms Script Tags
Replace tags for a script uploaded to a Workers for Platforms dispatch namespace.
PUT /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags - Destructive
Delete Workers for Platforms Script Tag
Delete a tag from a script uploaded to a Workers for Platforms dispatch namespace. On `api-version` dates on or after `2026-10-01`, `tag` identifies a key and the operation returns the complete updated tag map. Deleting a missing key succeeds. Earlier versions retain the legacy string-tag behavior and return a null result.
DELETE /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag} - Destructive
Create Workers for Platforms Script Tag
Add a single tag to a script uploaded to a Workers for Platforms dispatch namespace.
PUT /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}
Domains
- Read
List Worker Domains
Lists all Worker domains for an account.
GET /accounts/{account_id}/workers/domains - Read
Get Worker Domain
Gets information about a Worker domain.
GET /accounts/{account_id}/workers/domains/{domain_id} - Destructive
Attach Worker Domain
Attaches a domain that routes traffic to a Worker.
PUT /accounts/{account_id}/workers/domains - Destructive
Detach Worker Domain
Detaches a domain from a Worker. Both the Worker and all of its previews are no longer routable using this domain.
DELETE /accounts/{account_id}/workers/domains/{domain_id}
Durable Objects Namespace
- Read
List Durable Object Namespaces
Returns the Durable Object namespaces owned by an account.
GET /accounts/{account_id}/workers/durable_objects/namespaces - Read
List Objects in a Durable Object namespace
Returns the Durable Objects in a given Durable Object namespace.
GET /accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects - Read
Query a Durable Object
Executes one or more SQL queries against a Durable Object.
POST /accounts/{account_id}/workers/durable_objects/namespaces/{id}/query/v2
Agents
- Read
List Agent sessions
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.
GET /accounts/{account_id}/workers/observability/agents/sessions - Read
List Agent session runs
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.
GET /accounts/{account_id}/workers/observability/agents/sessions/{conversationId}/runs
Destinations
- Read
Get Destinations
List your Workers Observability Telemetry Destinations.
GET /accounts/{account_id}/workers/observability/destinations - Write
Create Destination
Create a new Workers Observability Telemetry Destination.
POST /accounts/{account_id}/workers/observability/destinations - Write
Update Destination
Update an existing Workers Observability Telemetry Destination.
PATCH /accounts/{account_id}/workers/observability/destinations/{slug} - Destructive
Delete Destination
Delete a Workers Observability Telemetry Destination.
DELETE /accounts/{account_id}/workers/observability/destinations/{slug}
Issues
- Read
List detected issues
List detected issues.
GET /accounts/{account_id}/workers/observability/issues - Read
List issue automations
List account and service issue automations.
GET /accounts/{account_id}/workers/observability/issues/automations - Read
Get an issue automation
Retrieve an issue automation.
GET /accounts/{account_id}/workers/observability/issues/automations/{automationId} - Read
Summarize detected issues
Retrieve aggregate issue counts for the account.
GET /accounts/{account_id}/workers/observability/issues/summary - Read
Get an issue
Retrieve an issue.
GET /accounts/{account_id}/workers/observability/issues/{issueId} - Read
List issue occurrences
List the retained error occurrences grouped into an issue, newest first.
GET /accounts/{account_id}/workers/observability/issues/{issueId}/occurrences - Write
Create an issue automation
Create an account or service issue automation.
POST /accounts/{account_id}/workers/observability/issues/automations - Write
Create an issue group
Group two or more issues under a new customer-defined identity.
POST /accounts/{account_id}/workers/observability/issues/groups - Write
Add issue group members
Add one or more ungrouped issues to an existing issue group.
POST /accounts/{account_id}/workers/observability/issues/groups/{groupId}/members - Write
Modify an issue
Modify an issue status or group title.
PATCH /accounts/{account_id}/workers/observability/issues/{issueId} - Write
Notify about an issue
Send the issue to one ANS policy, or every matching Real-Time Issue policy when no policy ID is provided.
POST /accounts/{account_id}/workers/observability/issues/{issueId}/notification-runs - Destructive
Delete an issue automation
Delete an issue automation while preserving its historical runs.
DELETE /accounts/{account_id}/workers/observability/issues/automations/{automationId} - Destructive
Update an issue automation
Replace an issue automation configuration.
PUT /accounts/{account_id}/workers/observability/issues/automations/{automationId} - Destructive
Dissolve an issue group
Dissolve an issue group and restore its members as standalone issues.
DELETE /accounts/{account_id}/workers/observability/issues/groups/{groupId} - Destructive
Remove an issue group member
Remove an issue from a group, dissolving the group when fewer than two members remain.
DELETE /accounts/{account_id}/workers/observability/issues/groups/{groupId}/members/{issueId}
Metrics Export
- Read
List Metrics Exports
List resources configured for Workers Observability metrics export.
GET /accounts/{account_id}/workers/observability/metricsexport - Write
Upsert Metrics Exports
Create or replace resources configured for Workers Observability metrics export.
POST /accounts/{account_id}/workers/observability/metricsexport
Saved Queries
- Read
List queries
List saved queries.
GET /accounts/{account_id}/workers/observability/queries - Read
Get query
Retrieve a saved query.
GET /accounts/{account_id}/workers/observability/queries/{queryId} - Write
Save query
Persist query for later use.
POST /accounts/{account_id}/workers/observability/queries - Write
Update query
Update saved query.
PATCH /accounts/{account_id}/workers/observability/queries/{queryId} - Destructive
Delete query
Delete a saved query.
DELETE /accounts/{account_id}/workers/observability/queries/{queryId}
Shared
Keys
- Read
List keys
List all the keys in your telemetry events.
POST /accounts/{account_id}/workers/observability/telemetry/keys
Live Tail
- Write
Prepare live tail
Prepare websocket server for live tail.
POST /accounts/{account_id}/workers/observability/telemetry/live-tail - Write
Live tail heartbeat
Notify live tail that user is still eligible to receive live events.
POST /accounts/{account_id}/workers/observability/telemetry/live-tail/heartbeat
Query run
- Write
Run a query
Run a temporary or saved query.
POST /accounts/{account_id}/workers/observability/telemetry/query
Values
- Read
List values
List unique values found in your events.
POST /accounts/{account_id}/workers/observability/telemetry/values
Usage
- Read
Get event count
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.
GET /accounts/{account_id}/workers/observability/usage
Workers Smart Placement
- Read
List Workers Smart Placement Regions
Returns a list of available placement regions organized by cloud provider. These regions can be used to configure Smart Placement for Workers.
GET /accounts/{account_id}/workers/placement/regions
Worker Deployments
- Read
List Worker Deployments
List Worker deployments. The first deployment in the list is the latest deployment actively serving traffic.
GET /accounts/{account_id}/workers/scripts/{script_name}/deployments - Read
Get Worker Deployment
Get information about a Worker Deployment.
GET /accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id} - Write
Create Worker Deployment
Deployments configure how [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions) are deployed to traffic. A deployment can consist of multiple versions of a Worker.
POST /accounts/{account_id}/workers/scripts/{script_name}/deployments - Destructive
Delete Worker Deployment
Delete a Worker Deployment. The latest deployment, which is actively serving traffic, cannot be deleted. All other deployments can be deleted.
DELETE /accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id}
Worker Cron Trigger
- Read
Get Worker Script Schedules (Cron Triggers)
Get the schedules (Cron Triggers) for a Worker script.
GET /accounts/{account_id}/workers/scripts/{script_name}/schedules - Destructive
Update Worker Script Schedules (Cron Triggers)
Update the schedules (Cron Triggers) for a Worker script.
PUT /accounts/{account_id}/workers/scripts/{script_name}/schedules
Worker Tail Logs
- Read
List Worker Tails
Get a list of tails currently deployed on a Worker.
GET /accounts/{account_id}/workers/scripts/{script_name}/tails - Write
Start Worker Tail
Starts a tail that receives logs and exceptions from a Worker.
POST /accounts/{account_id}/workers/scripts/{script_name}/tails - Destructive
Delete Worker Tail
Deletes a tail from a Worker.
DELETE /accounts/{account_id}/workers/scripts/{script_name}/tails/{id}
Worker Versions
- Read
List Versions
List of Worker Versions. The first version in the list is the latest version.
GET /accounts/{account_id}/workers/scripts/{script_name}/versions - Read
Get Worker Script Version
Retrieves detailed information about a specific version of a Worker script.
GET /accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id} - Destructive
Upload Version
Upload a Worker Version without deploying to Cloudflare's network. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.
POST /accounts/{account_id}/workers/scripts/{script_name}/versions
Worker Environment
- Read
Get Worker Environment Script Content
Get Worker script content for an environment.
GET /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content - Read
Get Worker Environment Settings
Get Worker script settings for an environment.
GET /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings - Write
Patch Worker Environment Settings
Patch Worker script metadata for an environment, such as bindings.
PATCH /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings - Destructive
Replace Worker Environment Script Content
Replace Worker script content for an environment.
PUT /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content
Worker Subdomain
- Read
Get a Workers Subdomain
Returns a Workers subdomain for an account.
GET /accounts/{account_id}/workers/subdomain - Destructive
Delete Workers Subdomain
Deletes a Workers subdomain for an account.
DELETE /accounts/{account_id}/workers/subdomain - Destructive
Create a Workers Subdomain
Creates a Workers subdomain for an account.
PUT /accounts/{account_id}/workers/subdomain
Previews
- Read
List Previews
List all Previews for a Worker.
GET /accounts/{account_id}/workers/workers/{worker_id}/previews - Read
Get Preview
Get details about a specific Preview.
GET /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id} - Write
Create Preview
Create a new Preview for a Worker.
POST /accounts/{account_id}/workers/workers/{worker_id}/previews - Write
Edit Preview
Perform a partial update on a Preview, where omitted properties are left unchanged.
PATCH /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id} - Destructive
Delete Preview
Delete a Preview.
DELETE /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id} - Destructive
Update Preview
Perform a complete replacement of a Preview, where omitted properties are set to defaults.
PUT /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id}
Preview Deployments
- Read
List Preview Deployments
List all deployments for a Preview.
GET /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id}/deployments - Read
Get Preview Deployment
Get details about a specific preview deployment.
GET /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id}/deployments/{deployment_id} - Destructive
Create Preview Deployment
Create a new deployment for a Preview.
POST /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id}/deployments - Destructive
Patch Latest Preview Deployment
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.
PATCH /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id}/deployments/latest - Destructive
Delete Preview Deployment
Delete a preview deployment.
DELETE /accounts/{account_id}/workers/workers/{worker_id}/previews/{preview_id}/deployments/{deployment_id}
Versions
- Read
List Worker Versions
List all versions for a Worker.
GET /accounts/{account_id}/workers/workers/{worker_id}/versions - Read
Get Latest Worker Version
Get details about the most recently created Worker version.
GET /accounts/{account_id}/workers/workers/{worker_id}/versions/latest - Read
Get Worker Version
Get details about a specific Worker version.
GET /accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id} - Destructive
Create Worker Version
Create a new version for a Worker.
POST /accounts/{account_id}/workers/workers/{worker_id}/versions - Destructive
Patch Latest Worker Version
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.
PATCH /accounts/{account_id}/workers/workers/{worker_id}/versions/latest - Destructive
Delete Worker Version
Delete a Worker version.
DELETE /accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id}
Worker Profiling
- Write
Profile Worker Version
Captures a CPU or heap profile from a recently active isolate running the specified Worker version. This endpoint requires the Worker profiling feature to be enabled for the account.
POST /accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id}/profile
Zero Trust Connectivity Settings
- Read
Get Zero Trust Connectivity Settings
Gets the Zero Trust Connectivity Settings for the given account.
GET /accounts/{account_id}/zerotrust/connectivity_settings - Write
Updates the Zero Trust Connectivity Settings
Updates the Zero Trust Connectivity Settings for the given account.
PATCH /accounts/{account_id}/zerotrust/connectivity_settings
Zero Trust Hostname Route
- Read
List hostname routes
Lists and filters hostname routes in an account.
GET /accounts/{account_id}/zerotrust/routes/hostname - Read
Get hostname route
Get a hostname route.
GET /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id} - Write
Create hostname route
Create a hostname route.
POST /accounts/{account_id}/zerotrust/routes/hostname - Write
Update hostname route
Updates a hostname route.
PATCH /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id} - Destructive
Delete hostname route
Delete a hostname route.
DELETE /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}
Zero Trust Subnets
- Read
List Subnets
Lists and filters subnets in an account.
GET /accounts/{account_id}/zerotrust/subnets - Read
Get Cloudflare Source Subnet
Returns the account's default Cloudflare Source subnet for the given address family.
GET /accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family} - Read
Get Initial Resolved IP Subnet
Returns the account's default Initial Resolved IP Subnet for the given address family.
GET /accounts/{account_id}/zerotrust/subnets/initial_resolved_ip/{address_family} - Read
Get WARP IP subnet
Get a WARP IP assignment subnet.
GET /accounts/{account_id}/zerotrust/subnets/warp/{subnet_id} - Write
Update Cloudflare Source Subnet
Updates the Cloudflare Source subnet of the given address family
PATCH /accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family} - Write
Create WARP IP subnet
Create a WARP IP assignment subnet. Currently, only IPv4 subnets can be created. **Network constraints:** - The network must be within one of the following private IP ranges: - `10.0.0.0/8` (RFC 1918) - `172.16.0.0/12` (RFC 1918) - `192.168.0.0/16` (RFC 1918) - `100.64.0.0/10` (RFC 6598 - CGNAT) - The subnet must have a prefix length of `/24` or larger (e.g., `/16`, `/20`, `/24` are valid; `/25`, `/28` are not)
POST /accounts/{account_id}/zerotrust/subnets/warp - Write
Update WARP IP subnet
Updates a WARP IP assignment subnet. **Update constraints:** - The `network` field cannot be modified for WARP subnets. Only `name`, `comment`, and `is_default_network` can be updated. - IPv6 subnets cannot be updated
PATCH /accounts/{account_id}/zerotrust/subnets/warp/{subnet_id} - Destructive
Update Initial Resolved IP Subnet
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.
PUT /accounts/{account_id}/zerotrust/subnets/initial_resolved_ip/{address_family} - Destructive
Delete WARP IP subnet
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.
DELETE /accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}
Zero Trust Risk Scoring
- Read
Get all behaviors and associated configuration
Retrieves configured risk score behaviors that define how user actions affect their overall risk score.
GET /accounts/{account_id}/zt_risk_scoring/behaviors - Read
Get risk score info for all users in the account
Gets an aggregate summary of risk scores across the account, including distribution and trends.
GET /accounts/{account_id}/zt_risk_scoring/summary - Read
Get risk event/score information for a specific user
Retrieves the detailed risk score breakdown for a specific user, including contributing factors.
GET /accounts/{account_id}/zt_risk_scoring/{user_id} - Destructive
Update configuration for risk behaviors
Updates risk score behavior configurations, defining weights and thresholds for risk calculation.
PUT /accounts/{account_id}/zt_risk_scoring/behaviors - Destructive
Clear the risk score for a particular user
Resets risk scores for specified users, clearing their accumulated risk history.
POST /accounts/{account_id}/zt_risk_scoring/{user_id}/reset
Zero Trust Risk Scoring Integrations
- Read
List all risk score integrations for the account.
Lists all configured Zero Trust risk score integrations for the account.
GET /accounts/{account_id}/zt_risk_scoring/integrations - Read
Get risk score integration by reference id.
Retrieves a Zero Trust risk score integration using its external reference ID.
GET /accounts/{account_id}/zt_risk_scoring/integrations/reference_id/{reference_id} - Read
Get risk score integration by id.
Gets a Zero Trust risk score integration by ID.
GET /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id} - Write
Create new risk score integration.
Creates a new Zero Trust risk score integration, connecting external risk signals to Cloudflare's risk scoring system.
POST /accounts/{account_id}/zt_risk_scoring/integrations - Destructive
Delete a risk score integration.
Removes a Zero Trust risk score integration, disconnecting the external risk signal source.
DELETE /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id} - Destructive
Update a risk score integration.
Overwrite the reference_id, tenant_url, and active values with the ones provided.
PUT /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}
Rate Plans
- Read
Get Rate Plan by Public Key
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.
GET /billing/rate_plans/{public_key}
Origin CA
- Read
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](#requests)).
GET /certificates - Read
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](#requests)).
GET /certificates/{certificate_id} - Write
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](#requests)).
POST /certificates - Destructive
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](#requests)).
DELETE /certificates/{certificate_id}
CWS Categories
- Read
List category APIs
Returns distinct active API names across every application or beneath an exact application name.
GET /cws/categories/apis - Read
List category applications
Returns active applications and their stable keys.
GET /cws/categories/applications - Read
List application versions
Lists immutable category bundle versions for an application.
GET /cws/categories/applications/{application_key}/versions - Read
Get the latest application version
Returns the latest immutable category bundle and supports conditional retrieval with If-None-Match.
GET /cws/categories/applications/{application_key}/versions/latest - Read
Get an application version
Returns a pinned immutable category bundle version.
GET /cws/categories/applications/{application_key}/versions/{version_tag} - Read
List category operations
Returns distinct active operation names across every path and supports independent exact application and API ancestor filters.
GET /cws/categories/operations
CWS Filter Schema
- Read
Get filter fields
Returns separate policy and workload field catalogs with metadata and UI hints for building filter expressions.
GET /cws/filter-schema
Cloudflare IPs
- Read
Cloudflare/JD Cloud 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.
GET /ips
User's Account Memberships
- Read
List Memberships
List memberships of accounts the user can access.
GET /memberships - Read
Membership Details
Get a specific membership.
GET /memberships/{membership_id} - Read
Get User Membership
Get a specific membership for the currently authenticated user.
GET /user/memberships/{membership_id} - Destructive
Delete Membership
Remove the associated member from an account.
DELETE /memberships/{membership_id} - Destructive
Update Membership
Accept or reject this account invitation.
PUT /memberships/{membership_id}
Organizations
- Read
List organizations the user has access to
Retrieve a list of organizations a particular user has access to.
GET /organizations - Read
Get organization
Retrieve the details of a certain organization.
GET /organizations/{organization_id} - Read
List organization accounts
Retrieve the accounts immediately attached to a specific organization. Accounts attached to sub-organizations are not included.
GET /organizations/{organization_id}/accounts - Read
Get organization profile
Get an organizations profile if it exists.
GET /organizations/{organization_id}/profile - Write
Create organization
Create a new organization for a user. Sub-organization creation availability depends on the organization's capabilities.
POST /organizations - Destructive
Delete organization
Delete an organization. The organization MUST be empty before deleting. It must not contain any sub-organizations, accounts, members or users. Sub-organization deletion availability depends on the organization's capabilities. **Access Control:** Restricted to enterprise organizations.
DELETE /organizations/{organization_id} - Destructive
Update organization
Update an organization's name.
PUT /organizations/{organization_id} - Destructive
Handle organization invite
Accept or reject an invitation to a specific organization. The credential must belong to the invited user. No additional API token permission is required.
PUT /organizations/{organization_id}/invites/{member_code} - Destructive
Modify organization profile.
Modify organization profile.
PUT /organizations/{organization_id}/profile
Organization Members
- Read
List organization members
List memberships for an Organization.
GET /organizations/{organization_id}/members - Read
Get organization member
Retrieve a single membership from an Organization.
GET /organizations/{organization_id}/members/{member_id} - Write
Create organization member
Create a membership that grants access to a specific Organization.
POST /organizations/{organization_id}/members - Write
Batch create organization members
Batch create multiple memberships that grant access to a specific Organization.
POST /organizations/{organization_id}/members:batchCreate - Destructive
Delete organization member
Delete a membership to a particular Organization.
DELETE /organizations/{organization_id}/members/{member_id}
Pages Assets
- Read
Check missing assets
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. Authenticate with the JWT obtained from the upload-token endpoint: GET /accounts/{account_id}/pages/projects/{project_name}/upload-token
POST /pages/assets/check-missing - Write
Upload asset
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. Authenticate with the JWT obtained from the upload-token endpoint: GET /accounts/{account_id}/pages/projects/{project_name}/upload-token
POST /pages/assets/upload - Write
Upsert asset 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. Authenticate with the JWT obtained from the upload-token endpoint: GET /accounts/{account_id}/pages/projects/{project_name}/upload-token
POST /pages/assets/upsert-hashes
Radar Agent Readiness
- Read
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.
GET /radar/agent_readiness/summary/{dimension}
Radar AI Bots
- Read
Get AI user agents summary (deprecated)
Retrieves the distribution of traffic by AI user agent.
GET /radar/ai/bots/summary/user_agent - Read
Get AI bots HTTP requests distribution by dimension
Retrieves an aggregated summary of AI bots HTTP requests grouped by the specified dimension.
GET /radar/ai/bots/summary/{dimension} - Read
Get AI bots HTTP requests time series
Retrieves AI bots HTTP request volume over time.
GET /radar/ai/bots/timeseries - Read
Get AI user agents time series (deprecated)
Retrieves the distribution of traffic by AI user agent over time.
GET /radar/ai/bots/timeseries_groups/user_agent - Read
Get time series distribution of AI bots HTTP requests by dimension.
Retrieves the distribution of HTTP requests from AI bots, grouped by the specified dimension over time.
GET /radar/ai/bots/timeseries_groups/{dimension}
Radar AI Inference
- Read
Get Workers AI models summary (deprecated)
Retrieves the distribution of the number of inferences by model.
GET /radar/ai/inference/summary/model - Read
Get Workers AI tasks summary (deprecated)
Retrieves the distribution of the number of inferences by task.
GET /radar/ai/inference/summary/task - Read
Get Workers AI inference distribution by dimension
Retrieves an aggregated summary of the number of inferences run on Workers AI, grouped by the specified dimension.
GET /radar/ai/inference/summary/{dimension} - Read
Get Workers AI models time series (deprecated)
Retrieves the distribution of the number of inferences by model over time.
GET /radar/ai/inference/timeseries_groups/model - Read
Get Workers AI tasks time series (deprecated)
Retrieves the distribution of the number of inferences by task over time.
GET /radar/ai/inference/timeseries_groups/task - Read
Get time series distribution of Workers AI inference by dimension.
Retrieves the distribution of the number of inferences run on Workers AI, grouped by the specified dimension over time.
GET /radar/ai/inference/timeseries_groups/{dimension}
Radar Markdown for Agents
- Read
Get AI markdown for agents reduction ratio summary
Retrieves the overall median HTML-to-markdown reduction ratio for AI agent requests over the given date range.
GET /radar/ai/markdown_for_agents/summary - Read
Get AI markdown for agents reduction ratio time series
Retrieves the median HTML-to-markdown reduction ratio over time for AI agent requests.
GET /radar/ai/markdown_for_agents/timeseries
Radar Annotations
- Read
Get latest annotations
Retrieves the latest annotations.
GET /radar/annotations - Read
Get latest Internet outages and anomalies
Retrieves the latest Internet outages and anomalies.
GET /radar/annotations/outages - Read
Get the number of outages by location
Retrieves the number of outages by location.
GET /radar/annotations/outages/locations - Read
Get annotation by ID
Retrieves a single annotation by ID.
GET /radar/annotations/{id}
Radar AS112
- Read
Get AS112 DNS queries by DNSSEC summary (deprecated)
Retrieves the distribution of DNS queries to AS112 by DNSSEC (DNS Security Extensions) support.
GET /radar/as112/summary/dnssec - Read
Get AS112 DNS queries by EDNS summary (deprecated)
Retrieves the distribution of DNS queries to AS112 by EDNS (Extension Mechanisms for DNS) support.
GET /radar/as112/summary/edns - Read
Get AS112 DNS queries by IP version summary (deprecated)
Retrieves the distribution of DNS queries to AS112 by IP version.
GET /radar/as112/summary/ip_version - Read
Get AS112 DNS queries by DNS protocol summary (deprecated)
Retrieves the distribution of DNS queries to AS112 by protocol.
GET /radar/as112/summary/protocol - Read
Get AS112 DNS queries by type summary (deprecated)
Retrieves the distribution of DNS queries to AS112 by type.
GET /radar/as112/summary/query_type - Read
Get AS112 DNS queries by response code summary (deprecated)
Retrieves the distribution of AS112 DNS requests classified by response code.
GET /radar/as112/summary/response_codes - Read
Get AS112 summary by dimension
Retrieves the distribution of AS112 queries by the specified dimension.
GET /radar/as112/summary/{dimension} - Read
Get AS112 DNS queries time series
Retrieves the AS112 DNS queries over time.
GET /radar/as112/timeseries - Read
Get AS112 DNS queries by DNSSEC support time series (deprecated)
Retrieves the distribution of AS112 DNS queries by DNSSEC (DNS Security Extensions) support over time.
GET /radar/as112/timeseries_groups/dnssec - Read
Get AS112 DNS queries by EDNS support summary (deprecated)
Retrieves the distribution of AS112 DNS queries by EDNS (Extension Mechanisms for DNS) support over time.
GET /radar/as112/timeseries_groups/edns - Read
Get AS112 DNS queries by IP version time series (deprecated)
Retrieves the distribution of AS112 DNS queries by IP version over time.
GET /radar/as112/timeseries_groups/ip_version - Read
Get AS112 DNS queries by DNS protocol time series (deprecated)
Retrieves the distribution of AS112 DNS requests classified by protocol over time.
GET /radar/as112/timeseries_groups/protocol - Read
Get AS112 DNS queries by type time series (deprecated)
Retrieves the distribution of AS112 DNS queries by type over time.
GET /radar/as112/timeseries_groups/query_type - Read
Get AS112 DNS queries by response code time series (deprecated)
Retrieves the distribution of AS112 DNS requests classified by response code over time.
GET /radar/as112/timeseries_groups/response_codes - Read
Get AS112 time series grouped by dimension
Retrieves the distribution of AS112 queries grouped by dimension over time.
GET /radar/as112/timeseries_groups/{dimension} - Read
Get top locations by AS112 DNS queries
Retrieves the top locations by AS112 DNS queries.
GET /radar/as112/top/locations - Read
Get top locations by AS112 DNS queries with DNSSEC support
Retrieves the top locations of DNS queries to AS112 with DNSSEC (DNS Security Extensions) support.
GET /radar/as112/top/locations/dnssec/{dnssec} - Read
Get top locations by AS112 DNS queries with EDNS support
Retrieves the top locations of DNS queries to AS112 with EDNS (Extension Mechanisms for DNS) support.
GET /radar/as112/top/locations/edns/{edns} - Read
Get top locations by AS112 DNS queries for an IP version
Retrieves the top locations of DNS queries to AS112 for an IP version.
GET /radar/as112/top/locations/ip_version/{ip_version}
Radar Layer 3 Attacks
- Read
Get layer 3 attacks by bitrate summary (deprecated)
Retrieves the distribution of layer 3 attacks by bitrate.
GET /radar/attacks/layer3/summary/bitrate - Read
Get layer 3 attacks by duration summary (deprecated)
Retrieves the distribution of layer 3 attacks by duration.
GET /radar/attacks/layer3/summary/duration - Read
Get layer 3 attacks by targeted industry summary (deprecated)
Retrieves the distribution of layer 3 attacks by targeted industry.
GET /radar/attacks/layer3/summary/industry - Read
Get layer 3 attacks by IP version summary (deprecated)
Retrieves the distribution of layer 3 attacks by IP version.
GET /radar/attacks/layer3/summary/ip_version - Read
Get layer 3 attacks by protocol summary (deprecated)
Retrieves the distribution of layer 3 attacks by protocol.
GET /radar/attacks/layer3/summary/protocol - Read
Get layer 3 attacks by vector summary (deprecated)
Retrieves the distribution of layer 3 attacks by vector.
GET /radar/attacks/layer3/summary/vector - Read
Get layer 3 attacks by targeted vertical summary (deprecated)
Retrieves the distribution of layer 3 attacks by targeted vertical.
GET /radar/attacks/layer3/summary/vertical - Read
Get layer 3 attacks summary by dimension
Retrieves the distribution of layer 3 attacks by the specified dimension.
GET /radar/attacks/layer3/summary/{dimension} - Read
Get layer 3 attacks by bytes time series
Retrieves layer 3 attacks over time.
GET /radar/attacks/layer3/timeseries - Read
Get layer 3 attacks by bitrate time series (deprecated)
Retrieves the distribution of layer 3 attacks by bitrate over time.
GET /radar/attacks/layer3/timeseries_groups/bitrate - Read
Get layer 3 attacks by duration time series (deprecated)
Retrieves the distribution of layer 3 attacks by duration over time.
GET /radar/attacks/layer3/timeseries_groups/duration - Read
Get layer 3 attacks by target industries time series (deprecated)
Retrieves the distribution of layer 3 attacks by targeted industry over time.
GET /radar/attacks/layer3/timeseries_groups/industry - Read
Get layer 3 attacks by IP version time series (deprecated)
Retrieves the distribution of layer 3 attacks by IP version over time.
GET /radar/attacks/layer3/timeseries_groups/ip_version - Read
Get layer 3 attacks by protocol time series (deprecated)
Retrieves the distribution of layer 3 attacks by protocol over time.
GET /radar/attacks/layer3/timeseries_groups/protocol - Read
Get layer 3 attacks by vector time series (deprecated)
Retrieves the distribution of layer 3 attacks by vector over time.
GET /radar/attacks/layer3/timeseries_groups/vector - Read
Get layer 3 attacks by vertical time series (deprecated)
Retrieves the distribution of layer 3 attacks by targeted vertical over time.
GET /radar/attacks/layer3/timeseries_groups/vertical - Read
Get layer 3 attacks time series grouped by dimension
Retrieves the distribution of layer 3 attacks grouped by dimension over time.
GET /radar/attacks/layer3/timeseries_groups/{dimension} - Read
Get top layer 3 attack pairs (origin and target locations)
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).
GET /radar/attacks/layer3/top/attacks - Read
Get top industries targeted by layer 3 attacks (deprecated)
This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint.
GET /radar/attacks/layer3/top/industry - Read
Get top origin locations of layer 3 attacks
Retrieves the origin locations of layer 3 attacks.
GET /radar/attacks/layer3/top/locations/origin - Read
Get top target locations of layer 3 attacks
Retrieves the target locations of layer 3 attacks.
GET /radar/attacks/layer3/top/locations/target - Read
Get top verticals targeted by layer 3 attacks (deprecated)
This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint.
GET /radar/attacks/layer3/top/vertical
Radar Layer 7 Attacks
- Read
Get layer 7 attacks by HTTP method summary (deprecated)
Retrieves the distribution of layer 7 attacks by HTTP method.
GET /radar/attacks/layer7/summary/http_method - Read
Get layer 7 attacks by HTTP version summary (deprecated)
Retrieves the distribution of layer 7 attacks by HTTP version.
GET /radar/attacks/layer7/summary/http_version - Read
Get layer 7 attacks by targeted industry summary (deprecated)
Retrieves the distribution of layer 7 attacks by targeted industry.
GET /radar/attacks/layer7/summary/industry - Read
Get layer 7 attacks by IP version summary (deprecated)
Retrieves the distribution of layer 7 attacks by IP version.
GET /radar/attacks/layer7/summary/ip_version - Read
Get layer 7 attacks by managed rules summary (deprecated)
Retrieves the distribution of layer 7 attacks by managed rules.
GET /radar/attacks/layer7/summary/managed_rules - Read
Get layer 7 attacks by mitigation product summary (deprecated)
Retrieves the distribution of layer 7 attacks by mitigation product.
GET /radar/attacks/layer7/summary/mitigation_product - Read
Get layer 7 attacks by targeted vertical summary (deprecated)
Retrieves the distribution of layer 7 attacks by targeted vertical.
GET /radar/attacks/layer7/summary/vertical - Read
Get layer 7 attacks summary by dimension
Retrieves the distribution of layer 7 attacks by the specified dimension.
GET /radar/attacks/layer7/summary/{dimension} - Read
Get layer 7 attacks time series
Retrieves layer 7 attacks over time.
GET /radar/attacks/layer7/timeseries - Read
Get layer 7 attacks by HTTP method time series (deprecated)
Retrieves the distribution of layer 7 attacks by HTTP method over time.
GET /radar/attacks/layer7/timeseries_groups/http_method - Read
Get layer 7 attacks by HTTP version time series (deprecated)
Retrieves the distribution of layer 7 attacks by HTTP version over time.
GET /radar/attacks/layer7/timeseries_groups/http_version - Read
Get layer 7 attacks by target industries time series (deprecated)
Retrieves the distribution of layer 7 attacks by targeted industry over time.
GET /radar/attacks/layer7/timeseries_groups/industry - Read
Get layer 7 attacks by IP version time series (deprecated)
Retrieves the distribution of layer 7 attacks by IP version used over time.
GET /radar/attacks/layer7/timeseries_groups/ip_version - Read
Get layer 7 attacks by managed rules time series (deprecated)
Retrieves the distribution of layer 7 attacks by managed rules over time.
GET /radar/attacks/layer7/timeseries_groups/managed_rules - Read
Get layer 7 attacks by mitigation product time series (deprecated)
Retrieves the distribution of layer 7 attacks by mitigation product over time.
GET /radar/attacks/layer7/timeseries_groups/mitigation_product - Read
Get layer 7 attacks by vertical time series (deprecated)
Retrieves the distribution of layer 7 attacks by targeted vertical over time.
GET /radar/attacks/layer7/timeseries_groups/vertical - Read
Get layer 7 attacks time series grouped by dimension
Retrieves the distribution of layer 7 attacks grouped by dimension over time.
GET /radar/attacks/layer7/timeseries_groups/{dimension} - Read
Get top origin ASes of layer 7 attacks
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.
GET /radar/attacks/layer7/top/ases/origin - Read
Get top layer 7 attack pairs (origin and target locations)
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).
GET /radar/attacks/layer7/top/attacks - Read
Get top industries targeted by layer 7 attacks (deprecated)
This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint.
GET /radar/attacks/layer7/top/industry - Read
Get top origin locations of layer 7 attacks
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.
GET /radar/attacks/layer7/top/locations/origin - Read
Get top target locations of layer 7 attacks
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.
GET /radar/attacks/layer7/top/locations/target - Read
Get top verticals targeted by layer 7 attacks (deprecated)
This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint.
GET /radar/attacks/layer7/top/vertical
Radar BGP
- Read
Get BGP hijack events
Retrieves the BGP hijack events.
GET /radar/bgp/hijacks/events - Read
Get announced IP address space time series
Retrieves time series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN.
GET /radar/bgp/ips/timeseries - Read
Get top ASes by announced IP space
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`.
GET /radar/bgp/ips/top/ases - Read
Get BGP route leak events
Retrieves the BGP route leak events.
GET /radar/bgp/leaks/events - Read
List ASes from global routing tables
Retrieves all ASes in the current global routing tables with routing statistics.
GET /radar/bgp/routes/ases - Read
Get Multi-Origin AS (MOAS) prefixes
Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables.
GET /radar/bgp/routes/moas - Read
Get tier-1 path segments for an AS
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).
GET /radar/bgp/routes/paths/{asn} - Read
Get prefix-to-ASN mapping
Retrieves the prefix-to-ASN mapping from global routing tables.
GET /radar/bgp/routes/pfx2as - Read
Get real-time BGP routes for a prefix
Retrieves real-time BGP routes for a prefix, using public real-time data collectors (RouteViews and RIPE RIS).
GET /radar/bgp/routes/realtime - Read
Get BGP routing table stats
Retrieves the BGP routing table stats.
GET /radar/bgp/routes/stats - Read
Get upstream composition time series for an AS
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.
GET /radar/bgp/routes/upstreams/{asn}/timeseries - Read
Get ASPA changes over time
Retrieves ASPA (Autonomous System Provider Authorization) changes over time. Returns daily aggregated changes including additions, removals, and modifications of ASPA objects.
GET /radar/bgp/rpki/aspa/changes - Read
Get ASPA objects snapshot
Retrieves current or historical ASPA (Autonomous System Provider Authorization) objects. ASPA objects define which ASNs are authorized upstream providers for a customer ASN.
GET /radar/bgp/rpki/aspa/snapshot - Read
Get ASPA count time series
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.
GET /radar/bgp/rpki/aspa/timeseries - Read
Get RPKI ROA deployment time series
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.
GET /radar/bgp/rpki/roas/timeseries - Read
Get BGP time series
Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned.
GET /radar/bgp/timeseries - Read
Get top ASes by BGP updates
Retrieves the top autonomous systems by BGP updates (announcements only).
GET /radar/bgp/top/ases - Read
Get top ASes by prefix count
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.
GET /radar/bgp/top/ases/prefixes - Read
Get top prefixes by BGP updates
Retrieves the top network prefixes by BGP updates.
GET /radar/bgp/top/prefixes
Radar Bots
- Read
List bots
Retrieves a list of bots.
GET /radar/bots - Read
Get bots HTTP requests distribution by dimension
Retrieves an aggregated summary of bots HTTP requests grouped by the specified dimension.
GET /radar/bots/summary/{dimension} - Read
Get bots HTTP requests time series
Retrieves bots HTTP request volume over time.
GET /radar/bots/timeseries - Read
Get time series distribution of bots HTTP requests by dimension.
Retrieves the distribution of HTTP requests from bots, grouped by the specified dimension over time.
GET /radar/bots/timeseries_groups/{dimension} - Read
Get bot details
Retrieves the requested bot information.
GET /radar/bots/{bot_slug}
Radar Web Crawlers
- Read
Get crawler HTTP request distribution by dimension
Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension.
GET /radar/bots/crawlers/summary/{dimension} - Read
Get time series of crawler HTTP request distribution by dimension
Retrieves the distribution of HTTP requests from crawlers, grouped by the specified dimension over time.
GET /radar/bots/crawlers/timeseries_groups/{dimension}
Radar Certificate Transparency
- Read
List certificate authorities
Retrieves a list of certificate authorities.
GET /radar/ct/authorities - Read
Get certificate authority details
Retrieves the requested CA information.
GET /radar/ct/authorities/{ca_slug} - Read
List certificate logs
Retrieves a list of certificate logs.
GET /radar/ct/logs - Read
Get certificate log details
Retrieves the requested certificate log information.
GET /radar/ct/logs/{log_slug} - Read
Get certificate distribution by dimension
Retrieves an aggregated summary of certificates grouped by the specified dimension.
GET /radar/ct/summary/{dimension} - Read
Get certificates time series
Retrieves certificate volume over time.
GET /radar/ct/timeseries - Read
Get time series of certificate distribution by dimension
Retrieves the distribution of certificates grouped by the specified dimension over time.
GET /radar/ct/timeseries_groups/{dimension}
Radar Datasets
- Read
List datasets
Retrieves a list of datasets.
GET /radar/datasets - Read
Get dataset download URL
Retrieves an URL to download a single dataset.
POST /radar/datasets/download - Read
Get dataset CSV stream
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.
GET /radar/datasets/{alias}
Radar DNS
- Read
Get DNS queries by cache status summary (deprecated)
Retrieves the distribution of DNS queries by cache status.
GET /radar/dns/summary/cache_hit - Read
Get DNS queries by DNSSEC support summary (deprecated)
Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support.
GET /radar/dns/summary/dnssec - Read
Get DNS queries by DNSSEC awareness summary (deprecated)
Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness.
GET /radar/dns/summary/dnssec_aware - Read
Get DNS queries by DNSSEC end-to-end summary (deprecated)
Retrieves the distribution of DNSSEC-validated answers by end-to-end security status.
GET /radar/dns/summary/dnssec_e2e - Read
Get DNS queries by IP version summary (deprecated)
Retrieves the distribution of DNS queries by IP version.
GET /radar/dns/summary/ip_version - Read
Get DNS queries by matching answer summary (deprecated)
Retrieves the distribution of DNS queries by matching answers.
GET /radar/dns/summary/matching_answer - Read
Get DNS queries by protocol summary (deprecated)
Retrieves the distribution of DNS queries by DNS transport protocol.
GET /radar/dns/summary/protocol - Read
Get DNS queries by type summary (deprecated)
Retrieves the distribution of DNS queries by type.
GET /radar/dns/summary/query_type - Read
Get DNS queries by response code summary (deprecated)
Retrieves the distribution of DNS queries by response code.
GET /radar/dns/summary/response_code - Read
Get DNS queries by response TTL summary (deprecated)
Retrieves the distribution of DNS queries by minimum response TTL.
GET /radar/dns/summary/response_ttl - Read
Get DNS summary by dimension
Retrieves the distribution of DNS queries by the specified dimension.
GET /radar/dns/summary/{dimension} - Read
Get DNS queries time series
Retrieves normalized query volume to the 1.1.1.1 DNS resolver over time.
GET /radar/dns/timeseries - Read
Get DNS queries by cache status time series (deprecated)
Retrieves the distribution of DNS queries by cache status over time.
GET /radar/dns/timeseries_groups/cache_hit - Read
Get DNS queries by DNSSEC support time series (deprecated)
Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support over time.
GET /radar/dns/timeseries_groups/dnssec - Read
Get DNS queries by DNSSEC awareness time series (deprecated)
Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness over time.
GET /radar/dns/timeseries_groups/dnssec_aware - Read
Get DNS queries by DNSSEC end-to-end time series (deprecated)
Retrieves the distribution of DNSSEC-validated answers by end-to-end security status over time.
GET /radar/dns/timeseries_groups/dnssec_e2e - Read
Get DNS queries by IP version time series (deprecated)
Retrieves the distribution of DNS queries by IP version over time.
GET /radar/dns/timeseries_groups/ip_version - Read
Get DNS queries by matching answer time series (deprecated)
Retrieves the distribution of DNS queries by matching answers over time.
GET /radar/dns/timeseries_groups/matching_answer - Read
Get DNS queries by protocol time series (deprecated)
Retrieves the distribution of DNS queries by DNS transport protocol over time.
GET /radar/dns/timeseries_groups/protocol - Read
Get DNS queries by type time series (deprecated)
Retrieves the distribution of DNS queries by type over time.
GET /radar/dns/timeseries_groups/query_type - Read
Get DNS queries by response code time series (deprecated)
Retrieves the distribution of DNS queries by response code over time.
GET /radar/dns/timeseries_groups/response_code - Read
Get DNS queries by response TTL time series (deprecated)
Retrieves the distribution of DNS queries by minimum answer TTL over time.
GET /radar/dns/timeseries_groups/response_ttl - Read
Get DNS time series grouped by dimension
Retrieves the distribution of DNS queries grouped by dimension over time.
GET /radar/dns/timeseries_groups/{dimension} - Read
Get top ASes by DNS queries
Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS resolver.
GET /radar/dns/top/ases - Read
Get top locations by DNS queries
Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver.
GET /radar/dns/top/locations
Radar Email Routing
- Read
Get email ARC validation summary (deprecated)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.
GET /radar/email/routing/summary/arc - Read
Get email DKIM validation summary (deprecated)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.
GET /radar/email/routing/summary/dkim - Read
Get email DMARC validation summary (deprecated)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.
GET /radar/email/routing/summary/dmarc - Read
Get email encryption status summary (deprecated)
Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted).
GET /radar/email/routing/summary/encrypted - Read
Get email IP version summary (deprecated)
Retrieves the distribution of emails by IP version.
GET /radar/email/routing/summary/ip_version - Read
Get email SPF validation summary (deprecated)
Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.
GET /radar/email/routing/summary/spf - Read
Get email routing summary by dimension
Retrieves the distribution of email routing metrics by the specified dimension.
GET /radar/email/routing/summary/{dimension} - Read
Get email ARC validation time series (deprecated)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.
GET /radar/email/routing/timeseries_groups/arc - Read
Get email DKIM validation time series (deprecated)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.
GET /radar/email/routing/timeseries_groups/dkim - Read
Get email DMARC validation time series (deprecated)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.
GET /radar/email/routing/timeseries_groups/dmarc - Read
Get email encryption status time series (deprecated)
Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted) over time.
GET /radar/email/routing/timeseries_groups/encrypted - Read
Get email IP version time series (deprecated)
Retrieves the distribution of emails by IP version over time.
GET /radar/email/routing/timeseries_groups/ip_version - Read
Get email SPF validation time series (deprecated)
Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time.
GET /radar/email/routing/timeseries_groups/spf - Read
Get email routing time series grouped by dimension
Retrieves the distribution of email routing metrics grouped by dimension over time.
GET /radar/email/routing/timeseries_groups/{dimension}
Radar Email Security
- Read
Get email ARC validation summary (deprecated)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.
GET /radar/email/security/summary/arc - Read
Get email DKIM validation summary (deprecated)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.
GET /radar/email/security/summary/dkim - Read
Get email DMARC validation summary (deprecated)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.
GET /radar/email/security/summary/dmarc - Read
Get email malicious classification summary (deprecated)
Retrieves the distribution of emails by malicious classification.
GET /radar/email/security/summary/malicious - Read
Get email spam classification summary (deprecated)
Retrieves the proportion of emails by spam classification (spam vs. non-spam).
GET /radar/email/security/summary/spam - Read
Get email SPF validation summary (deprecated)
Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.
GET /radar/email/security/summary/spf - Read
Get email spoof classification summary (deprecated)
Retrieves the proportion of emails by spoof classification (spoof vs. non-spoof).
GET /radar/email/security/summary/spoof - Read
Get email threat category summary (deprecated)
Retrieves the distribution of emails by threat categories.
GET /radar/email/security/summary/threat_category - Read
Get email TLS version summary (deprecated)
Retrieves the distribution of emails by TLS version.
GET /radar/email/security/summary/tls_version - Read
Get email security summary by dimension
Retrieves the distribution of email security metrics by the specified dimension.
GET /radar/email/security/summary/{dimension} - Read
Get email ARC validation time series (deprecated)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.
GET /radar/email/security/timeseries_groups/arc - Read
Get email DKIM validation time series (deprecated)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.
GET /radar/email/security/timeseries_groups/dkim - Read
Get email DMARC validation time series (deprecated)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.
GET /radar/email/security/timeseries_groups/dmarc - Read
Get email malicious classification time series (deprecated)
Retrieves the distribution of emails by malicious classification over time.
GET /radar/email/security/timeseries_groups/malicious - Read
Get email spam classification time series (deprecated)
Retrieves the distribution of emails by spam classification (spam vs. non-spam) over time.
GET /radar/email/security/timeseries_groups/spam - Read
Get email SPF validation time series (deprecated)
Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time.
GET /radar/email/security/timeseries_groups/spf - Read
Get email spoof classification time series (deprecated)
Retrieves the distribution of emails by spoof classification (spoof vs. non-spoof) over time.
GET /radar/email/security/timeseries_groups/spoof - Read
Get email threat category time series (deprecated)
Retrieves the distribution of emails by threat category over time.
GET /radar/email/security/timeseries_groups/threat_category - Read
Get email TLS version time series (deprecated)
Retrieves the distribution of emails by TLS version over time.
GET /radar/email/security/timeseries_groups/tls_version - Read
Get email security time series grouped by dimension
Retrieves the distribution of email security metrics grouped by dimension over time.
GET /radar/email/security/timeseries_groups/{dimension} - Read
Get top TLDs by email message volume
Retrieves the top TLDs by number of email messages.
GET /radar/email/security/top/tlds - Read
Get top TLDs by email malicious classification
Retrieves the top TLDs by emails classified as malicious or not.
GET /radar/email/security/top/tlds/malicious/{malicious} - Read
Get top TLDs by email spam classification
Retrieves the top TLDs by emails classified as spam or not.
GET /radar/email/security/top/tlds/spam/{spam} - Read
Get top TLDs by email spoof classification
Retrieves the top TLDs by emails classified as spoof or not.
GET /radar/email/security/top/tlds/spoof/{spoof}
Radar Autonomous Systems
- Read
List autonomous systems
Retrieves a list of autonomous systems.
GET /radar/entities/asns - Read
Get AS rankings by botnet threat feed activity
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.
GET /radar/entities/asns/botnet_threat_feed - Read
Get AS details by IP address
Retrieves the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).
GET /radar/entities/asns/ip - Read
Get AS details by ASN
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).
GET /radar/entities/asns/{asn} - Read
Get IRR AS-SETs that an AS is a member of
Retrieves Internet Routing Registry AS-SETs that an AS is a member of.
GET /radar/entities/asns/{asn}/as_set - Read
Get AS-level relationships by ASN
Retrieves AS-level relationship for given networks.
GET /radar/entities/asns/{asn}/rel
Radar IP
- Read
Get IP address details
Retrieves IP address information.
GET /radar/entities/ip
Radar Locations
- Read
List locations
Retrieves a list of locations.
GET /radar/entities/locations - Read
Get location details
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).
GET /radar/entities/locations/{location}
Radar Geolocations
- Read
List 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`).
GET /radar/geolocations - Read
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`).
GET /radar/geolocations/{geo_id}
Radar HTTP
- Read
Get HTTP requests by bot class summary (deprecated)
Retrieves the distribution of bot-generated HTTP requests to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.
GET /radar/http/summary/bot_class - Read
Get HTTP requests by device type summary (deprecated)
Retrieves the distribution of HTTP requests generated by mobile, desktop, and other types of devices.
GET /radar/http/summary/device_type - Read
Get HTTP requests by HTTP/HTTPS summary (deprecated)
Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS).
GET /radar/http/summary/http_protocol - Read
Get HTTP requests by HTTP version summary (deprecated)
Retrieves the distribution of HTTP requests by HTTP version.
GET /radar/http/summary/http_version - Read
Get HTTP requests by IP version summary (deprecated)
Retrieves the distribution of HTTP requests by IP version.
GET /radar/http/summary/ip_version - Read
Get HTTP requests by OS summary (deprecated)
Retrieves the distribution of HTTP requests by operating system (Windows, macOS, Android, iOS, and others).
GET /radar/http/summary/os - Read
Get HTTP requests by post-quantum support summary (deprecated)
Retrieves the distribution of HTTP requests by post-quantum support.
GET /radar/http/summary/post_quantum - Read
Get HTTP requests by TLS version summary (deprecated)
Retrieves the distribution of HTTP requests by TLS version.
GET /radar/http/summary/tls_version - Read
Get HTTP requests summary by dimension
Retrieves the distribution of HTTP requests by the specified dimension.
GET /radar/http/summary/{dimension} - Read
Get HTTP requests time series
Retrieves the HTTP requests over time.
GET /radar/http/timeseries - Read
Get HTTP requests by bot class time series (deprecated)
Retrieves the distribution of HTTP requests classified as automated or human over time. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.
GET /radar/http/timeseries_groups/bot_class - Read
Get HTTP requests by user agent time series (deprecated)
Retrieves the distribution of HTTP requests by user agent over time.
GET /radar/http/timeseries_groups/browser - Read
Get HTTP requests by user agent family time series (deprecated)
Retrieves the distribution of HTTP requests by user agent family over time.
GET /radar/http/timeseries_groups/browser_family - Read
Get HTTP requests by device type time series (deprecated)
Retrieves the distribution of HTTP requests by device type over time.
GET /radar/http/timeseries_groups/device_type - Read
Get HTTP requests by HTTP/HTTPS time series (deprecated)
Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS) over time.
GET /radar/http/timeseries_groups/http_protocol - Read
Get HTTP requests by HTTP version time series (deprecated)
Retrieves the distribution of HTTP requests by HTTP version over time.
GET /radar/http/timeseries_groups/http_version - Read
Get HTTP requests by IP version time series (deprecated)
Retrieves the distribution of HTTP requests by IP version over time.
GET /radar/http/timeseries_groups/ip_version - Read
Get HTTP requests by OS time series (deprecated)
Retrieves the distribution of HTTP requests by operating system over time.
GET /radar/http/timeseries_groups/os - Read
Get HTTP requests by post-quantum support time series (deprecated)
Retrieves the distribution of HTTP requests by post-quantum support over time.
GET /radar/http/timeseries_groups/post_quantum - Read
Get HTTP requests by TLS version time series (deprecated)
Retrieves the distribution of HTTP requests by TLS version over time.
GET /radar/http/timeseries_groups/tls_version - Read
Get HTTP requests time series grouped by dimension
Retrieves the distribution of HTTP requests grouped by dimension.
GET /radar/http/timeseries_groups/{dimension} - Read
Get top ASes by HTTP requests
Retrieves the top autonomous systems by HTTP requests.
GET /radar/http/top/ases - Read
Get top ASes by HTTP requests for a bot class
Retrieves the top autonomous systems, by HTTP requests, of the requested bot class.
GET /radar/http/top/ases/bot_class/{bot_class} - Read
Get top ASes by HTTP requests for a browser family
Retrieves the top autonomous systems, by HTTP requests, of the requested browser family.
GET /radar/http/top/ases/browser_family/{browser_family} - Read
Get top ASes by HTTP requests for a device type
Retrieves the top autonomous systems, by HTTP requests, of the requested device type.
GET /radar/http/top/ases/device_type/{device_type} - Read
Get top ASes by HTTP requests for an HTTP protocol
Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP protocol.
GET /radar/http/top/ases/http_protocol/{http_protocol} - Read
Get top ASes by HTTP requests for an HTTP version
Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP version.
GET /radar/http/top/ases/http_version/{http_version} - Read
Get top ASes by HTTP requests for an IP version
Retrieves the top autonomous systems, by HTTP requests, of the requested IP version.
GET /radar/http/top/ases/ip_version/{ip_version} - Read
Get top ASes by HTTP requests for an OS
Retrieves the top autonomous systems, by HTTP requests, of the requested operating system.
GET /radar/http/top/ases/os/{os} - Read
Get top ASes by HTTP requests for a TLS version
Retrieves the top autonomous systems, by HTTP requests, of the requested TLS protocol version.
GET /radar/http/top/ases/tls_version/{tls_version} - Read
Get top user agents by HTTP requests (deprecated)
Retrieves the top user agents by HTTP requests.
GET /radar/http/top/browser - Read
Get top user agent families by HTTP requests (deprecated)
Retrieves the top user agents, aggregated in families, by HTTP requests.
GET /radar/http/top/browser_family - Read
Get top locations by HTTP requests
Retrieves the top locations by HTTP requests.
GET /radar/http/top/locations - Read
Get top locations by HTTP requests for a bot class
Retrieves the top locations, by HTTP requests, of the requested bot class.
GET /radar/http/top/locations/bot_class/{bot_class} - Read
Get top locations by HTTP requests for a browser family
Retrieves the top locations, by HTTP requests, of the requested browser family.
GET /radar/http/top/locations/browser_family/{browser_family} - Read
Get top locations by HTTP requests for a device type
Retrieves the top locations, by HTTP requests, of the requested device type.
GET /radar/http/top/locations/device_type/{device_type} - Read
Get top locations by HTTP requests for an HTTP protocol
Retrieves the top locations, by HTTP requests, of the requested HTTP protocol.
GET /radar/http/top/locations/http_protocol/{http_protocol} - Read
Get top locations by HTTP requests for an HTTP version
Retrieves the top locations, by HTTP requests, of the requested HTTP version.
GET /radar/http/top/locations/http_version/{http_version} - Read
Get top locations by HTTP requests for an IP version
Retrieves the top locations, by HTTP requests, of the requested IP version.
GET /radar/http/top/locations/ip_version/{ip_version} - Read
Get top locations by HTTP requests for an OS
Retrieves the top locations, by HTTP requests, of the requested operating system.
GET /radar/http/top/locations/os/{os} - Read
Get top locations by HTTP requests for a TLS version
Retrieves the top locations, by HTTP requests, of the requested TLS protocol version.
GET /radar/http/top/locations/tls_version/{tls_version}
Radar Leaked Credential Checks
- Read
Get HTTP authentication requests by bot class summary (deprecated)
Retrieves the distribution of HTTP authentication requests by bot class.
GET /radar/leaked_credential_checks/summary/bot_class - Read
Get HTTP authentication requests by compromised credential status summary (deprecated)
Retrieves the distribution of HTTP authentication requests by compromised credential status.
GET /radar/leaked_credential_checks/summary/compromised - Read
Get HTTP authentication requests distribution by dimension
Retrieves an aggregated summary of HTTP authentication requests grouped by the specified dimension.
GET /radar/leaked_credential_checks/summary/{dimension} - Read
Get HTTP authentication requests by bot class time series (deprecated)
Retrieves the distribution of HTTP authentication requests by bot class over time.
GET /radar/leaked_credential_checks/timeseries_groups/bot_class - Read
Get HTTP authentication requests by compromised credential status time series (deprecated)
Retrieves the distribution of HTTP authentication requests by compromised credential status over time.
GET /radar/leaked_credential_checks/timeseries_groups/compromised - Read
Get time series distribution of HTTP authentication requests by dimension.
Retrieves the distribution of HTTP authentication requests, grouped by the specified dimension over time.
GET /radar/leaked_credential_checks/timeseries_groups/{dimension}
Radar NetFlows
- Read
Get network traffic summary (deprecated)
Retrieves the distribution of network traffic (NetFlows) by HTTP vs other protocols.
GET /radar/netflows/summary
Radar Net Flows
- Read
Get network traffic distribution by dimension
Retrieves the distribution of network traffic (NetFlows) by the specified dimension.
GET /radar/netflows/summary/{dimension} - Read
Get network traffic time series
Retrieves network traffic (NetFlows) over time.
GET /radar/netflows/timeseries - Read
Get time series distribution of network traffic by dimension
Retrieves the distribution of NetFlows traffic, grouped by the specified dimension over time.
GET /radar/netflows/timeseries_groups/{dimension} - Read
Get top ASes by network traffic
Retrieves the top autonomous systems by network traffic (NetFlows).
GET /radar/netflows/top/ases - Read
Get top locations by network traffic
Retrieves the top locations by network traffic (NetFlows).
GET /radar/netflows/top/locations
Radar Origins
- Read
List Origins
Retrieves a list of origins with their regions.
GET /radar/origins - Read
Get origin metrics distribution by dimension
Retrieves an aggregated summary of origin metrics grouped by the specified dimension.
GET /radar/origins/summary/{dimension} - Read
Get origin metrics time series
Retrieves the time series of origin metrics for the specified origin.
GET /radar/origins/timeseries - Read
Get origin metrics time series grouped by dimension
Retrieves the distribution of origin metrics grouped by the specified dimension over time.
GET /radar/origins/timeseries_groups/{dimension} - Read
Get Origin details
Retrieves the requested origin information with its regions.
GET /radar/origins/{slug}
Radar Post Quantum
- Read
Get Origin Post-Quantum Data Summary
Returns a summary of origin post-quantum data grouped by the specified dimension.
GET /radar/post_quantum/origin/summary/{dimension} - Read
Get Origin Post-Quantum Data Over Time
Returns a timeseries of origin post-quantum data grouped by the specified dimension.
GET /radar/post_quantum/origin/timeseries_groups/{dimension} - Read
Check 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.).
GET /radar/post_quantum/tls/support
Radar Quality
- Read
Get Internet Quality Index (IQI) summary
Retrieves a summary (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI).
GET /radar/quality/iqi/summary - Read
Get Internet Quality Index (IQI) time series
Retrieves a time series (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI).
GET /radar/quality/iqi/timeseries_groups - Read
Get speed tests 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.
GET /radar/quality/speed/histogram - Read
Get speed tests summary
Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the previous 90 days of Cloudflare Speed Test data.
GET /radar/quality/speed/summary - Read
Get top ASes by speed test results
Retrieves the top autonomous systems by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data.
GET /radar/quality/speed/top/ases - Read
Get top locations by speed test results
Retrieves the top locations by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data.
GET /radar/quality/speed/top/locations
Radar Domains Ranking
- Read
Get domain rank 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.
GET /radar/ranking/domain/{domain} - Read
Get domains rank time series
Retrieves domains rank over time.
GET /radar/ranking/timeseries_groups - Read
Get top or trending 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/.
GET /radar/ranking/top
Radar Internet Services Ranking
- Read
List Internet services categories
Retrieves the list of Internet services categories.
GET /radar/ranking/internet_services/categories - Read
Get Internet services rank time series
Retrieves Internet Services rank update changes over time.
GET /radar/ranking/internet_services/timeseries_groups - Read
Get top Internet services
Retrieves top Internet services based on their rank.
GET /radar/ranking/internet_services/top
Radar Robots.txt
- Read
Get top domain categories by robots.txt files parsed
Retrieves the top domain categories by the number of robots.txt files parsed.
GET /radar/robots_txt/top/domain_categories - Read
Get top user agents on robots.txt files
Retrieves the top user agents on robots.txt files.
GET /radar/robots_txt/top/user_agents/directive
Radar Search
- Read
Search for locations, ASes, reports, and more
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`).
GET /radar/search/global
Radar TCP Resets and Timeouts
- Read
Get TCP resets and timeouts summary
Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout.
GET /radar/tcp_resets_timeouts/summary - Read
Get TCP resets and timeouts time series
Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout over time.
GET /radar/tcp_resets_timeouts/timeseries_groups
Radar Top Level Domains
- Read
List TLDs
Retrieves a list of TLDs.
GET /radar/tlds - Read
Get TLD Performance Summary
Returns a summary of TLD authoritative nameserver performance grouped by the specified dimension.
GET /radar/tlds/performance/summary/{dimension} - Read
Get TLD Performance Over Time
Returns a timeseries of TLD authoritative nameserver performance grouped by the specified dimension.
GET /radar/tlds/performance/timeseries_groups/{dimension} - Read
Get TLD details
Retrieves the requested TLD information.
GET /radar/tlds/{tld}
Radar Traffic Anomalies
- Read
Get latest Internet 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.
GET /radar/traffic_anomalies - Read
Get top locations by total traffic anomalies
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.
GET /radar/traffic_anomalies/locations - Read
Get traffic anomaly by UUID
Retrieves a single Internet traffic anomaly by UUID.
GET /radar/traffic_anomalies/{uuid}
Radar Verified Bots
- Read
Get top verified bots by HTTP requests (deprecated)
Retrieves the top verified bots by HTTP requests, with owner and category.
GET /radar/verified_bots/top/bots - Read
Get top verified bot categories by HTTP requests (deprecated)
Retrieves the top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.
GET /radar/verified_bots/top/categories
Tenants
- Read
Get tenant details
Retrieves a tenant's identity, status, metadata, contacts, and organizational units.
GET /tenants/{tenant_id} - Read
List tenant account types
Lists the account types this tenant is allowed to provision.
GET /tenants/{tenant_id}/account_types - Read
List tenant accounts
Lists the Cloudflare accounts associated with this tenant.
GET /tenants/{tenant_id}/accounts - Read
List tenant entitlements
Retrieves the innate and custom entitlement allocations available to this tenant.
GET /tenants/{tenant_id}/entitlements - Read
List tenant memberships
Lists active Cloudflare users with memberships in this tenant.
GET /tenants/{tenant_id}/memberships
Tenant Level Custom Nameservers
- Read
List Tenant Custom Nameservers
Lists a tenant's custom nameservers.
GET /tenants/{tenant_id}/custom_ns - Write
Add Tenant Custom Nameserver
Adds a custom nameserver for a tenant.
POST /tenants/{tenant_id}/custom_ns - Destructive
Delete Tenant Custom Nameserver
Deletes a tenant's custom nameserver.
DELETE /tenants/{tenant_id}/custom_ns/{custom_ns_id}
User
- Read
User Details
Retrieves detailed information about the currently authenticated user, including email, name, and account memberships.
GET /user - Read
List user tenants
Retrieves list of tenants the authenticated user / method has access to.
GET /user/tenants - Write
Edit User
Edit part of your user details.
PATCH /user
User Analytics (Deprecated)
- Read
Get user analytics dashboard (deprecated)
The user analytics dashboard provides totals and timeseries data aggregated across all zones owned by the authenticated user for the given time period. Only zones for which the user has the `#analytics:read` permission are included. This endpoint is deprecated. Please use the GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/
GET /user/analytics/dashboard
User Billing History
- Read
Billing History Details (deprecated)
Accesses your billing history object.
GET /user/billing/history
User Billing Profile
- Read
Billing Profile Details (deprecated)
Accesses your billing profile object.
GET /user/billing/profile
Communication Preferences
- Read
Get communication preferences
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.
GET /user/communication_preferences - Destructive
Update communication preferences
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.
PUT /user/communication_preferences
IP Access rules for a user
- Read
List IP Access rules
Fetches IP Access rules of the user. You can filter the results using several optional parameters.
GET /user/firewall/access_rules/rules - Read
Get an IP Access rule
Fetches the details of an IP Access rule defined at the user level.
GET /user/firewall/access_rules/rules/{rule_id} - Write
Create an IP Access rule
Creates a new IP Access rule for all zones owned by the current user. Note: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.
POST /user/firewall/access_rules/rules - Write
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.
PATCH /user/firewall/access_rules/rules/{rule_id} - Destructive
Delete an IP Access rule
Deletes an IP Access rule at the user level. Note: Deleting a user-level rule will affect all zones owned by the user.
DELETE /user/firewall/access_rules/rules/{rule_id}
User's Invites
- Read
List Invitations
Lists all invitations associated with my user.
GET /user/invites - Read
Invitation Details
Gets the details of an invitation.
GET /user/invites/{invite_id} - Write
Respond to Invitation
Responds to an invitation.
PATCH /user/invites/{invite_id}
Load Balancer Monitors
- Read
List Monitors
List configured monitors for a user.
GET /user/load_balancers/monitors - Read
Monitor Details
Fetch a single configured monitor for a user.
GET /user/load_balancers/monitors/{monitor_id} - Read
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.
POST /user/load_balancers/monitors/{monitor_id}/preview - Read
List Monitor References
Get the list of resources that reference the provided monitor.
GET /user/load_balancers/monitors/{monitor_id}/references - Read
Preview Result
Get the result of a previous preview operation using the provided preview_id.
GET /user/load_balancers/preview/{preview_id} - Write
Create Monitor
Create a configured monitor.
POST /user/load_balancers/monitors - Write
Patch Monitor
Apply changes to an existing monitor, overwriting the supplied properties.
PATCH /user/load_balancers/monitors/{monitor_id} - Destructive
Delete Monitor
Delete a configured monitor.
DELETE /user/load_balancers/monitors/{monitor_id} - Destructive
Update Monitor
Modify a configured monitor.
PUT /user/load_balancers/monitors/{monitor_id}
Load Balancer Pools
- Read
List Pools
List configured pools.
GET /user/load_balancers/pools - Read
Pool Details
Fetch a single configured pool.
GET /user/load_balancers/pools/{pool_id} - Read
Pool Health Details
Fetch the latest pool health status for a single pool.
GET /user/load_balancers/pools/{pool_id}/health - Read
Preview Pool
Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
POST /user/load_balancers/pools/{pool_id}/preview - Read
List Pool References
Get the list of resources that reference the provided pool.
GET /user/load_balancers/pools/{pool_id}/references - Write
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`.
PATCH /user/load_balancers/pools - Write
Create Pool
Create a new pool.
POST /user/load_balancers/pools - Write
Patch Pool
Apply changes to an existing pool, overwriting the supplied properties.
PATCH /user/load_balancers/pools/{pool_id} - Destructive
Delete Pool
Delete a configured pool.
DELETE /user/load_balancers/pools/{pool_id} - Destructive
Update Pool
Modify a configured pool.
PUT /user/load_balancers/pools/{pool_id}
Load Balancer Healthcheck Events
- Read
List Healthcheck Events
List origin health changes.
GET /user/load_balancing_analytics/events
User's Organizations
- Read
List Organizations (deprecated)
Lists organizations the user is associated with.
GET /user/organizations - Read
Organization Details (deprecated)
Gets a specific organization the user is associated with.
GET /user/organizations/{organization_id} - Destructive
Leave Organization (deprecated)
Removes association to an organization.
DELETE /user/organizations/{organization_id}
Spectrum Analytics
- Read
Get zones bandwidth report
Retrieves a list of total bandwidth by zone over a given time period.
GET /user/spectrum_analytics/zones/report - Read
Get current aggregated analytics
Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.
GET /zones/{zone_id}/spectrum/analytics/aggregate/current - Read
Get analytics by time
Retrieves a list of aggregate metrics grouped by time interval.
GET /zones/{zone_id}/spectrum/analytics/events/bytime - Read
Get analytics summary
Retrieves a list of summarised aggregate metrics over a given time period.
GET /zones/{zone_id}/spectrum/analytics/events/summary
User Subscription
- Read
Get User Subscriptions
Lists all of a user's subscriptions.
GET /user/subscriptions - Write
Create User Subscription
Creates a user subscription.
POST /user/subscriptions - Destructive
Delete User Subscription
Deletes a user's subscription.
DELETE /user/subscriptions/{identifier} - Destructive
Update User Subscription
Updates a user's subscriptions.
PUT /user/subscriptions/{identifier}
User API Tokens
- Read
List Tokens
List all access tokens you created. Results include active, disabled, and recently-expired tokens when include_expired is set to true.
GET /user/tokens - Read
List Token Permission Groups
Find all available permission groups for API Tokens.
GET /user/tokens/permission_groups - Read
Verify Token
Test whether a token works.
GET /user/tokens/verify - Read
Token Details
Get information about a specific token.
GET /user/tokens/{token_id} - Write
Create Token
Create a new access token.
POST /user/tokens - Destructive
Delete Token
Destroy a token.
DELETE /user/tokens/{token_id} - Destructive
Update Token
Update an existing token.
PUT /user/tokens/{token_id} - Destructive
Roll Token
Roll the token secret.
PUT /user/tokens/{token_id}/value
Api
- Read
Serve a provider template
Providers are the external parties that are configured to interact with Cloudflare.
GET /v2/domainTemplates/providers/{provider}/services/{service} - Read
Serve a provider configuration
Provides Stratus with extra information about domain connect provider(s).
GET /v2/provconf/{provider}/{service}/{account} - Read
Provide settings if domain is served by Cloudflare
Checks whether a domain is in Quicksilver and returns its settings.
GET /v2/{domain}/settings - Write
Request domain connect validation
Validates a Domain Connect signed request using DNS TXT public keys.
POST /v1/verify
Zone
- Read
List Zones
Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed.
GET /zones - Read
Zone Details
Retrieves detailed information about a specific zone identified by its zone ID. Returns zone configuration, status, nameservers, and associated metadata.
GET /zones/{zone_id} - Write
Create Zone
Creates a new zone (domain) in your Cloudflare account. The zone is created in a pending state and must be activated by updating your domain's nameservers to point to Cloudflare, or by completing the verification process for partial (CNAME) setups.
POST /zones - Write
Edit Zone
Edits a zone. Only one zone property can be changed at a time.
PATCH /zones/{zone_id} - Write
Invalidate Cached Content by Environment
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. Environments are part of [Version Management](https://developers.cloudflare.com/version-management/). To delete the content instead, use `POST /zones/{zone_id}/environments/{environment_id}/purge_cache`. Invalidating by URL (`files`) does not work for environments that select requests by IP address, country, ASN, or threat score, and fails with error `1136`. Use `tags`, `hosts`, `prefixes`, or `purge_everything` for those environments. ### Availability and limits Rate limits and the number of items you can send in one request depend on your plan. See [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
POST /zones/{zone_id}/environments/{environment_id}/invalidate_cache - Write
Invalidate Cached Content
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: - If your origin answers `304 Not Modified`, Cloudflare serves the cached copy without downloading it again, and `CF-Cache-Status` is `REVALIDATED`. - If your origin sends a full response, Cloudflare serves and caches the new content, and `CF-Cache-Status` is `EXPIRED`. With Tiered Cache, each tier revalidates with the tier above it, so a visitor can see `EXPIRED` even when your origin answered `304`. Until content is revalidated, your `stale-while-revalidate` and `stale-if-error` directives still apply, counted from the time you invalidated it. For example, if your origin fails during revalidation, Cloudflare can keep serving the stale copy for the `stale-if-error` window. ### Invalidate or purge? - **Invalidate** when content may not have changed, for example after a deploy. Unchanged content costs your origin a `304` instead of a full response. That saving needs an origin that sends `ETag` or `Last-Modified` and answers conditional requests. Otherwise, every revalidation downloads the full response. - **Purge**, with `POST /zones/{zone_id}/purge_cache`, when content must not be served again, for example content you removed for legal or security reasons. Invalidating takes the same request bodies as purging, needs the same permission, and counts against the same rate limits. After a broad invalidation, such as `purge_everything`, expect more conditional requests to your origin while visitors request the invalidated content again. ### Choose what to invalidate Send one of these fields in the request body: - `files`: specific URLs. If your cache key includes request headers, send each URL with the header values it was cached with. - `tags`: all content whose `Cache-Tag` response header contains one of the tags. - `hosts`: all content cached for the hostnames. - `prefixes`: all content whose URL starts with one of the prefixes. - `purge_everything`: all cached content in the zone. ### Check the result A `200` response with `success: true` means Cloudflare accepted the request. To check, request an invalidated URL and confirm that the `CF-Cache-Status` response header is `REVALIDATED` or `EXPIRED`. ### Availability and limits Rate limits and the number of items you can send in one request depend on your plan. See [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
POST /zones/{zone_id}/invalidate_cache - Destructive
Delete Zone
Deletes an existing zone.
DELETE /zones/{zone_id} - Destructive
Rerun the 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.
PUT /zones/{zone_id}/activation_check - Destructive
Purge Cached Content by Environment
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. Environments are part of [Version Management](https://developers.cloudflare.com/version-management/). To keep content cached and have Cloudflare revalidate it instead, use `POST /zones/{zone_id}/environments/{environment_id}/invalidate_cache`. Purging by URL (`files`) does not work for environments that select requests by IP address, country, ASN, or threat score, and fails with error `1136`. Use `tags`, `hosts`, `prefixes`, or `purge_everything` for those environments. ### Availability and limits Rate limits and the number of items you can send in one request depend on your plan. See [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
POST /zones/{zone_id}/environments/{environment_id}/purge_cache - Destructive
Purge Cached Content
Deletes cached content in every Cloudflare data center and cache tier, including Cache Reserve. The next request for purged content is a cache `MISS`: Cloudflare fetches the full response from your origin and caches it again. Cloudflare does not serve purged content from cache again, even if your origin is unavailable. To keep content cached and have Cloudflare revalidate it with your origin instead, use `POST /zones/{zone_id}/invalidate_cache`. ### Choose what to purge Send one of these fields in the request body: - `files`: specific URLs. If your cache key includes request headers, send each URL with the header values it was cached with. - `tags`: all content whose `Cache-Tag` response header contains one of the tags. - `hosts`: all content cached for the hostnames. - `prefixes`: all content whose URL starts with one of the prefixes. - `purge_everything`: all cached content in the zone. ### Check the result A `200` response with `success: true` means Cloudflare accepted the request. It does not confirm that any content was cached or removed. To check, request a purged URL and confirm that the `CF-Cache-Status` response header is `MISS`. ### Availability and limits Rate limits and the number of items you can send in one request depend on your plan. See [Purge cache: availability and limits](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
POST /zones/{zone_id}/purge_cache
Zone Level Access applications
- Read
List Access Applications
List all Access Applications in a zone.
GET /zones/{zone_id}/access/apps - Read
Get an Access application
Fetches information about an Access application.
GET /zones/{zone_id}/access/apps/{app_id} - Read
Test Access policies
Tests if a specific user has permission to access an application.
GET /zones/{zone_id}/access/apps/{app_id}/user_policy_checks - Write
Add an Access application
Adds a new application to Access.
POST /zones/{zone_id}/access/apps - Write
Update application settings
Updates application settings.
PATCH /zones/{zone_id}/access/apps/{app_id}/settings - Destructive
Delete an Access application
Deletes an application from Access.
DELETE /zones/{zone_id}/access/apps/{app_id} - Destructive
Update an Access application
Updates an Access application.
PUT /zones/{zone_id}/access/apps/{app_id} - Destructive
Revoke application tokens
Revokes all tokens issued for an application.
POST /zones/{zone_id}/access/apps/{app_id}/revoke_tokens - Destructive
Update application settings
Updates application settings.
PUT /zones/{zone_id}/access/apps/{app_id}/settings
Zone Level Access short lived certificate CAs
- Read
List short-lived certificate CAs
Lists short-lived certificate CAs and their public keys.
GET /zones/{zone_id}/access/apps/ca - Read
Get a short-lived certificate CA
Fetches a short-lived certificate CA and its public key.
GET /zones/{zone_id}/access/apps/{app_id}/ca - Write
Create a short-lived certificate CA
Generates a new short-lived certificate CA and public key.
POST /zones/{zone_id}/access/apps/{app_id}/ca - Destructive
Delete a short-lived certificate CA
Deletes a short-lived certificate CA.
DELETE /zones/{zone_id}/access/apps/{app_id}/ca
Zone Level Access policies
- Read
List Access policies
Lists Access policies configured for an application.
GET /zones/{zone_id}/access/apps/{app_id}/policies - Read
Get an Access policy
Fetches a single Access policy.
GET /zones/{zone_id}/access/apps/{app_id}/policies/{policy_id} - Write
Create an Access policy
Create a new Access policy for an application.
POST /zones/{zone_id}/access/apps/{app_id}/policies - Destructive
Delete an Access policy
Delete an Access policy.
DELETE /zones/{zone_id}/access/apps/{app_id}/policies/{policy_id} - Destructive
Update an Access policy
Update a configured Access policy.
PUT /zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}
Zone Level Access m TLS authentication
- Read
List mTLS certificates
Lists all mTLS certificates.
GET /zones/{zone_id}/access/certificates - Read
List all mTLS hostname settings
List all mTLS hostname settings for this zone.
GET /zones/{zone_id}/access/certificates/settings - Read
Get an mTLS certificate
Fetches a single mTLS certificate.
GET /zones/{zone_id}/access/certificates/{certificate_id} - Write
Add an mTLS certificate
Adds a new mTLS root certificate to Access.
POST /zones/{zone_id}/access/certificates - Destructive
Update an mTLS certificate's hostname settings
Updates an mTLS certificate's hostname settings.
PUT /zones/{zone_id}/access/certificates/settings - Destructive
Delete an mTLS certificate
Deletes an mTLS certificate.
DELETE /zones/{zone_id}/access/certificates/{certificate_id} - Destructive
Update an mTLS certificate
Updates a configured mTLS certificate.
PUT /zones/{zone_id}/access/certificates/{certificate_id}
Zone Level Access groups
- Read
List Access groups
Lists all Access groups.
GET /zones/{zone_id}/access/groups - Read
Get an Access group
Fetches a single Access group.
GET /zones/{zone_id}/access/groups/{group_id} - Write
Create an Access group
Creates a new Access group.
POST /zones/{zone_id}/access/groups - Destructive
Delete an Access group
Deletes an Access group.
DELETE /zones/{zone_id}/access/groups/{group_id} - Destructive
Update an Access group
Updates a configured Access group.
PUT /zones/{zone_id}/access/groups/{group_id}
Zone Level Access identity providers
- Read
List Access identity providers
Lists all configured identity providers.
GET /zones/{zone_id}/access/identity_providers - Read
Get an Access identity provider
Fetches a configured identity provider.
GET /zones/{zone_id}/access/identity_providers/{identity_provider_id} - Write
Add an Access identity provider
Adds a new identity provider to Access.
POST /zones/{zone_id}/access/identity_providers - Destructive
Delete an Access identity provider
Deletes an identity provider from Access.
DELETE /zones/{zone_id}/access/identity_providers/{identity_provider_id} - Destructive
Update an Access identity provider
Updates a configured identity provider.
PUT /zones/{zone_id}/access/identity_providers/{identity_provider_id}
Zone Level Zero Trust organization
- Read
Get your Zero Trust organization
Returns the configuration for your Zero Trust organization.
GET /zones/{zone_id}/access/organizations - Write
Create your Zero Trust organization
Sets up a Zero Trust organization for your account.
POST /zones/{zone_id}/access/organizations - Destructive
Update your Zero Trust organization
Updates the configuration for your Zero Trust organization.
PUT /zones/{zone_id}/access/organizations - Destructive
Revoke all Access tokens for a user
Revokes a user's access across all applications.
POST /zones/{zone_id}/access/organizations/revoke_user
Zone Level Access service tokens
- Read
List service tokens
Lists all service tokens.
GET /zones/{zone_id}/access/service_tokens - Read
Get a service token
Fetches a single service token.
GET /zones/{zone_id}/access/service_tokens/{service_token_id} - Write
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.
POST /zones/{zone_id}/access/service_tokens - Destructive
Delete a service token
Deletes a service token.
DELETE /zones/{zone_id}/access/service_tokens/{service_token_id} - Destructive
Update a service token
Updates a configured service token.
PUT /zones/{zone_id}/access/service_tokens/{service_token_id}
Custom Origin Trust Store
- Read
List Custom Origin Trust Store Details
Get Custom Origin Trust Store for a Zone.
GET /zones/{zone_id}/acm/custom_trust_store - Read
Custom Origin Trust Store Details
Retrieves details about a specific root CA certificate in the custom origin trust store, including expiration and subject information.
GET /zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id} - Write
Upload Custom Origin Trust Store
Upload a root CA certificate to the Custom Origin Trust Store for a Zone. Only root CA certificates are accepted.
POST /zones/{zone_id}/acm/custom_trust_store - Destructive
Delete Custom Origin Trust Store
Removes a root CA certificate from the custom origin trust store. Origins using certificates signed by this CA will no longer be trusted.
DELETE /zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}
Total TLS
- Read
Total TLS Settings Details
Get Total TLS Settings for a Zone.
GET /zones/{zone_id}/acm/total_tls - Write
Enable or Disable Total TLS
Set Total TLS Settings or disable the feature for a Zone.
POST /zones/{zone_id}/acm/total_tls
AI Audit
- Read
Get robots.txt rules
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.
GET /zones/{zone_id}/ai-audit/robots - Write
Bulk get robots.txt rules
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.
POST /zones/{zone_id}/ai-audit/robots/bulk
AI Security for Apps
- Read
Get the AI Security for Apps custom topics of a zone.
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.
GET /zones/{zone_id}/ai-security/custom-topics - Read
Get the AI Security for Apps status for a zone.
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.
GET /zones/{zone_id}/ai-security/settings - Destructive
Update the AI Security for Apps custom topics of a zone.
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. Each entry has a `label`, used to reference the topic in rule expressions and analytics, and a `topic` description, which the classifier scores prompts against while AI Security for Apps is enabled. The following rules apply: - A zone can hold at most 20 topics. - `label` must be 2–20 characters, using only lowercase letters (a–z), digits (0–9), and hyphens. - `topic` must be 2–50 UTF-8 bytes. Text in any language is supported, including spaces, numbers, punctuation, and symbols. Tabs, line breaks, invalid text, and invisible formatting characters are not allowed. - Labels must be unique within the zone, and so must topic descriptions.
PUT /zones/{zone_id}/ai-security/custom-topics - Destructive
Update the AI Security for Apps status for a zone.
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.
PUT /zones/{zone_id}/ai-security/settings
Zone Analytics (Deprecated)
- Read
Get analytics by Co-locations (deprecated)
This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.
GET /zones/{zone_id}/analytics/colos - Read
Get dashboard (deprecated)
The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network.
GET /zones/{zone_id}/analytics/dashboard
Argo Analytics for Zone
- Read
Argo Analytics for a zone
Retrieves aggregate Argo Smart Routing analytics for a zone, including latency improvements, bandwidth savings, and routing statistics.
GET /zones/{zone_id}/analytics/latency
Argo Analytics for Geolocation
- Read
Argo Analytics for a zone at different PoPs
Retrieves Argo Smart Routing analytics broken down by geographic points of presence (PoPs). Shows latency improvements and routing efficiency per location.
GET /zones/{zone_id}/analytics/latency/colos
API Shield Settings
- Read
Get session identifier settings
Returns the authentication identifier characteristics configured for the zone. Header, cookie, or JWT claim values identify distinct API sessions.
GET /zones/{zone_id}/api_gateway/configuration - Destructive
Update session identifier settings
Replaces the zone's authentication identifier characteristics used to identify distinct API sessions.
PUT /zones/{zone_id}/api_gateway/configuration
API Shield API Discovery
- Read
Export discovered API operations as OpenAPI schemas
Returns the latest API operations discovered from zone traffic, rendered as OpenAPI schemas.
GET /zones/{zone_id}/api_gateway/discovery - Read
List discovered web and API operations
Returns the latest web and API operations discovered from zone traffic.
GET /zones/{zone_id}/api_gateway/discovery/operations - Read
Get a discovered web or API operation
Returns a discovered web or API operation by discovery ID.
GET /zones/{zone_id}/api_gateway/discovery/operations/{discovery_id} - Write
Edit discovered web and API operations
Updates the state of one or more discovered web and API operations.
PATCH /zones/{zone_id}/api_gateway/discovery/operations - Write
Edit a discovered web or API operation
Updates the state of a discovered web or API operation.
PATCH /zones/{zone_id}/api_gateway/discovery/operations/{discovery_id}
API Shield WAF Expression Templates
- Write
Generate a fallthrough WAF expression template (deprecated)
Generates a WAF expression template that matches fallthrough traffic for the supplied API hosts. This operation is deprecated and should not be used for new integrations.
POST /zones/{zone_id}/api_gateway/expression-template/fallthrough
API Shield Labels
- Read
List operation labels
Returns all managed and user-defined labels available for web and API operations in the zone.
GET /zones/{zone_id}/api_gateway/labels - Read
Get a managed operation label
Returns a managed label and the web and API operations associated with it.
GET /zones/{zone_id}/api_gateway/labels/managed/{name} - Read
Get a user-defined operation label
Returns a user-defined label and the web and API operations associated with it.
GET /zones/{zone_id}/api_gateway/labels/user/{name} - Write
Create user-defined operation labels
Creates one or more user-defined labels for classifying web and API operations.
POST /zones/{zone_id}/api_gateway/labels/user - Write
Edit a user-defined operation label
Updates only the supplied fields on a user-defined label.
PATCH /zones/{zone_id}/api_gateway/labels/user/{name} - Write
Attach labels to web or API operations
Attaches labels to multiple web or API operations in one request.
POST /zones/{zone_id}/api_gateway/operations/labels - Write
Attach labels to a web or API operation
Attaches one or more labels to a web or API operation.
POST /zones/{zone_id}/api_gateway/operations/{operation_id}/labels - Destructive
Replace operations attached to a managed label
Replaces the complete set of web and API operations attached to the managed label.
PUT /zones/{zone_id}/api_gateway/labels/managed/{name}/resources/operation - Destructive
Delete user-defined operation labels
Deletes one or more user-defined labels and removes their associations with web and API operations.
DELETE /zones/{zone_id}/api_gateway/labels/user - Destructive
Delete a user-defined operation label
Deletes a user-defined label and removes its associations with web and API operations.
DELETE /zones/{zone_id}/api_gateway/labels/user/{name} - Destructive
Update a user-defined operation label
Replaces all editable fields on a user-defined label.
PUT /zones/{zone_id}/api_gateway/labels/user/{name} - Destructive
Replace operations attached to a user-defined label
Replaces the complete set of web and API operations attached to the user-defined label.
PUT /zones/{zone_id}/api_gateway/labels/user/{name}/resources/operation - Destructive
Remove labels from web or API operations
Removes labels from multiple web or API operations in one request.
DELETE /zones/{zone_id}/api_gateway/operations/labels - Destructive
Replace labels on web or API operations
Replaces the complete label sets on multiple web or API operations in one request.
PUT /zones/{zone_id}/api_gateway/operations/labels - Destructive
Remove labels from a web or API operation
Removes one or more labels from a web or API operation.
DELETE /zones/{zone_id}/api_gateway/operations/{operation_id}/labels - Destructive
Replace labels on a web or API operation
Replaces the complete label set on a web or API operation.
PUT /zones/{zone_id}/api_gateway/operations/{operation_id}/labels
API Shield Endpoint Management
- Read
List web and API operations
Lists web and API operations tracked for the zone, including each operation's method, path, and feature configuration.
GET /zones/{zone_id}/api_gateway/operations - Read
Get a web or API operation
Returns a web or API operation, including its schema validation settings and requested feature data.
GET /zones/{zone_id}/api_gateway/operations/{operation_id} - Read
Export web and API operations as OpenAPI schemas
Returns tracked web and API operations and their feature configuration rendered as OpenAPI schemas.
GET /zones/{zone_id}/api_gateway/schemas - Write
Create web or API operations
Creates one or more web or API operations. Hosts, methods, and paths are normalized; an existing matching operation is returned instead of duplicated.
POST /zones/{zone_id}/api_gateway/operations - Write
Create a web or API operation
Creates one web or API operation. The host, method, and path are normalized; an existing matching operation is returned instead of duplicated.
POST /zones/{zone_id}/api_gateway/operations/item - Destructive
Delete web or API operations
Deletes multiple web or API operations from endpoint management in one request.
DELETE /zones/{zone_id}/api_gateway/operations - Destructive
Delete a web or API operation
Deletes a web or API operation from endpoint management so its feature configuration is no longer tracked.
DELETE /zones/{zone_id}/api_gateway/operations/{operation_id}
API Shield Schema Validation 2.0
- Read
Retrieve operation-level schema validation settings (deprecated)
Retrieves operation-level schema validation settings on the zone. Deprecated; use `/zones/{zone_id}/schema_validation/settings/operations/{operation_id}` instead.
GET /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation - Read
Retrieve zone level schema validation settings (deprecated)
Retrieves zone level schema validation settings currently set on the zone. Deprecated; use `/zones/{zone_id}/schema_validation/settings` instead.
GET /zones/{zone_id}/api_gateway/settings/schema_validation - Read
Retrieve information about all schemas on a zone (deprecated)
Lists all OpenAPI schemas uploaded to API Shield for the zone, including their validation status and associated operations. Deprecated; use `/zones/{zone_id}/schema_validation/schemas` instead.
GET /zones/{zone_id}/api_gateway/user_schemas - Read
Retrieve schema hosts in a zone (deprecated)
Lists all unique hosts found in uploaded OpenAPI schemas for the zone. Useful for understanding which domains have schema coverage. Deprecated; use `/zones/{zone_id}/schema_validation/schemas/hosts` instead.
GET /zones/{zone_id}/api_gateway/user_schemas/hosts - Read
Retrieve information about a specific schema on a zone (deprecated)
Gets detailed information about a specific uploaded OpenAPI schema, including its contents and validation configuration. Deprecated; use `/zones/{zone_id}/schema_validation/schemas/{schema_id}` instead.
GET /zones/{zone_id}/api_gateway/user_schemas/{schema_id} - Read
Retrieve all operations from a schema (deprecated)
Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations. Deprecated; use `/zones/{zone_id}/schema_validation/schemas/{schema_id}/operations` instead.
GET /zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations - Write
Update multiple operation-level schema validation settings (deprecated)
Updates multiple operation-level schema validation settings on the zone. Deprecated; use `/zones/{zone_id}/schema_validation/settings/operations` instead.
PATCH /zones/{zone_id}/api_gateway/operations/schema_validation - Write
Update zone level schema validation settings (deprecated)
Updates zone level schema validation settings on the zone. Deprecated; use `/zones/{zone_id}/schema_validation/settings` instead.
PATCH /zones/{zone_id}/api_gateway/settings/schema_validation - Write
Upload a legacy schema (deprecated)
Uploads an OpenAPI schema that defines expected request formats for API endpoints. Deprecated; use `/zones/{zone_id}/schema_validation/schemas` instead.
POST /zones/{zone_id}/api_gateway/user_schemas - Write
Enable validation for a schema (deprecated)
Activates schema validation for an uploaded OpenAPI schema. Requests to matching endpoints will be validated against the schema definitions. Deprecated; use `/zones/{zone_id}/schema_validation/schemas/{schema_id}` instead.
PATCH /zones/{zone_id}/api_gateway/user_schemas/{schema_id} - Destructive
Update operation-level schema validation settings (deprecated)
Updates operation-level schema validation settings on the zone. Deprecated; use `/zones/{zone_id}/schema_validation/settings/operations/{operation_id}` instead.
PUT /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation - Destructive
Update zone level schema validation settings (deprecated)
Updates zone level schema validation settings on the zone. Deprecated; use `/zones/{zone_id}/schema_validation/settings` instead.
PUT /zones/{zone_id}/api_gateway/settings/schema_validation - Destructive
Delete a schema (deprecated)
Permanently removes an uploaded OpenAPI schema from API Shield schema validation. Operations using this schema will lose their validation rules. Deprecated; use `/zones/{zone_id}/schema_validation/schemas/{schema_id}` instead.
DELETE /zones/{zone_id}/api_gateway/user_schemas/{schema_id}
Tiered Caching
- Read
Get Tiered Caching setting
Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of lower-tiers and upper-tiers. If content is not cached in lower-tier data centers (generally the ones closest to a visitor), the lower-tier must ask an upper-tier to see if it has the content. If the upper-tier does not have the content, only the upper-tier can ask the origin for content. This practice improves bandwidth efficiency by limiting the number of data centers that can ask the origin for content, which reduces origin load and makes websites more cost-effective to operate. Additionally, Tiered Cache concentrates connections to origin servers so they come from a small number of data centers rather than the full set of network locations. This results in fewer open connections using server resources.
GET /zones/{zone_id}/argo/tiered_caching - Write
Patch Tiered Caching setting
Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of lower-tiers and upper-tiers. If content is not cached in lower-tier data centers (generally the ones closest to a visitor), the lower-tier must ask an upper-tier to see if it has the content. If the upper-tier does not have the content, only the upper-tier can ask the origin for content. This practice improves bandwidth efficiency by limiting the number of data centers that can ask the origin for content, which reduces origin load and makes websites more cost-effective to operate. Additionally, Tiered Cache concentrates connections to origin servers so they come from a small number of data centers rather than the full set of network locations. This results in fewer open connections using server resources.
PATCH /zones/{zone_id}/argo/tiered_caching
Zone Rate Plan
- Read
List Available Plans
Lists available plans the zone can subscribe to.
GET /zones/{zone_id}/available_plans - Read
Available Plan Details
Details of the available plan that the zone can subscribe to.
GET /zones/{zone_id}/available_plans/{plan_identifier} - Read
List Available Rate Plans
Lists all rate plans the zone can subscribe to.
GET /zones/{zone_id}/available_rate_plans
Bot Settings
- Read
Get Zone Bot Management Config
Retrieve a zone's Bot Management Config
GET /zones/{zone_id}/bot_management - Destructive
Update Zone Bot Management Config
Updates the Bot Management configuration for a zone. This API is used to update: - **Bot Fight Mode** - **Super Bot Fight Mode** - **Bot Management for Enterprise** See [Bot Plans](https://developers.cloudflare.com/bots/plans/) for more information on the different plans \ If you recently upgraded or downgraded your plan, refer to the following examples to clean up old configurations. Copy and paste the example body to remove old zone configurations based on your current plan. #### Clean up configuration for Bot Fight Mode plan ```json { "sbfm_likely_automated": "allow", "sbfm_definitely_automated": "allow", "sbfm_verified_bots": "allow", "sbfm_static_resource_protection": false, "optimize_wordpress": false, "suppress_session_score": false } ``` #### Clean up configuration for SBFM Pro plan ```json { "sbfm_likely_automated": "allow", "fight_mode": false } ``` #### Clean up configuration for SBFM Biz plan ```json { "fight_mode": false } ``` #### Clean up configuration for BM Enterprise Subscription plan It is strongly recommended that you ensure you have [custom rules](https://developers.cloudflare.com/waf/custom-rules/) in place to protect your zone before disabling the SBFM rules. Without these protections, your zone is vulnerable to attacks. ```json { "sbfm_likely_automated": "allow", "sbfm_definitely_automated": "allow", "sbfm_verified_bots": "allow", "sbfm_static_resource_protection": false, "optimize_wordpress": false, "fight_mode": false } ```
PUT /zones/{zone_id}/bot_management
Feedback
- Read
List zone feedback reports
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.
GET /zones/{zone_id}/bot_management/feedback - Write
Submit a feedback report
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. See more accepted API fields and expression types at https://developers.cloudflare.com/bots/concepts/feedback-loop/#api-fields and https://developers.cloudflare.com/bots/concepts/feedback-loop/#expression-fields, respectively.
POST /zones/{zone_id}/bot_management/feedback
Zone Cache Settings
- Read
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](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.
GET /zones/{zone_id}/cache/cache_reserve - Read
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.
GET /zones/{zone_id}/cache/cache_reserve_clear - Read
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.
GET /zones/{zone_id}/cache/regional_tiered_cache - Read
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.
GET /zones/{zone_id}/cache/variants - Write
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](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.
PATCH /zones/{zone_id}/cache/cache_reserve - Write
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.
PATCH /zones/{zone_id}/cache/regional_tiered_cache - Write
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.
PATCH /zones/{zone_id}/cache/variants - Destructive
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.
POST /zones/{zone_id}/cache/cache_reserve_clear - Destructive
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.
DELETE /zones/{zone_id}/cache/variants
Origin Cloud Regions
- Read
List origin cloud region mappings (deprecated)
Returns all IP-to-cloud-region mappings configured for the zone. 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.
GET /zones/{zone_id}/cache/origin_cloud_regions - Read
List supported cloud vendors and regions (deprecated)
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.
GET /zones/{zone_id}/cache/origin_cloud_regions/supported_regions - Read
Get an origin cloud region mapping (deprecated)
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 (code 1142) if the zone has no mappings or if the specified IP has no mapping.
GET /zones/{zone_id}/cache/origin_cloud_regions/{origin_ip} - Read
List origin cloud region mappings
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.
GET /zones/{zone_id}/origin/cloud_regions - Read
List supported cloud vendors and 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.
GET /zones/{zone_id}/origin/cloud_regions/supported_regions - Read
Get an origin cloud region mapping
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.
GET /zones/{zone_id}/origin/cloud_regions/{origin_ip} - Write
Create or update an origin cloud region mapping (deprecated)
Adds or updates a single IP-to-cloud-region mapping for the zone. Unlike POST, this operation is idempotent — if a mapping for the IP already exists it is overwritten. Returns the complete updated list of all mappings for the zone. Returns 403 (code 1164) when the zone has reached the limit of 3,500 IP mappings.
PATCH /zones/{zone_id}/cache/origin_cloud_regions - Write
Create an origin cloud region mapping (deprecated)
Adds a single IP-to-cloud-region mapping for the zone. The IP must be a valid IPv4 or IPv6 address and is normalized to canonical form before storage (RFC 5952 for IPv6). Returns 400 (code 1145) if a mapping for that IP already exists — use PATCH to update an existing entry. The vendor and region are validated against the list from `GET /zones/{zone_id}/cache/origin_cloud_regions/supported_regions`.
POST /zones/{zone_id}/cache/origin_cloud_regions - Write
Batch create or update origin cloud region mappings (deprecated)
Adds or updates up to 100 IP-to-cloud-region mappings in a single request. 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}/cache/origin_cloud_regions/supported_regions`.
PATCH /zones/{zone_id}/cache/origin_cloud_regions/batch - Destructive
Batch delete origin cloud region mappings (deprecated)
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.
DELETE /zones/{zone_id}/cache/origin_cloud_regions/batch - Destructive
Delete an origin cloud region mapping (deprecated)
Removes the cloud region mapping for a single origin IP address. The IP path parameter is normalized before lookup. Returns the deleted entry on success. Returns 404 (code 1163) if no mapping exists for the specified IP. When the last mapping for the zone is removed the underlying rule record is also deleted.
DELETE /zones/{zone_id}/cache/origin_cloud_regions/{origin_ip} - Destructive
Batch delete origin cloud region mappings
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.
DELETE /zones/{zone_id}/origin/cloud_regions/batch - Destructive
Batch create or replace origin cloud region mappings
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`.
PUT /zones/{zone_id}/origin/cloud_regions/batch - Destructive
Delete an origin cloud region mapping
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.
DELETE /zones/{zone_id}/origin/cloud_regions/{origin_ip} - Destructive
Create or replace an origin cloud region mapping
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.
PUT /zones/{zone_id}/origin/cloud_regions/{origin_ip}
Origin Post-Quantum
- Read
Get Origin Post-Quantum Encryption setting (deprecated)
Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised.
GET /zones/{zone_id}/cache/origin_post_quantum_encryption - Destructive
Change Origin Post-Quantum Encryption setting (deprecated)
Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised.
PUT /zones/{zone_id}/cache/origin_post_quantum_encryption
Smart Tiered Cache
- Read
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.
GET /zones/{zone_id}/cache/tiered_cache_smart_topology_enable - Write
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.
PATCH /zones/{zone_id}/cache/tiered_cache_smart_topology_enable - Write
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.
POST /zones/{zone_id}/cache/tiered_cache_smart_topology_enable - Destructive
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.
DELETE /zones/{zone_id}/cache/tiered_cache_smart_topology_enable
API Shield Client Certificates for a Zone
- Read
List Hostname Associations
List Hostname Associations.
GET /zones/{zone_id}/certificate_authorities/hostname_associations - Read
List Client Certificates
List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination.
GET /zones/{zone_id}/client_certificates - Read
Client Certificate Details
Get Details for a single mTLS API Shield Client Certificate.
GET /zones/{zone_id}/client_certificates/{client_certificate_id} - Write
Create Client Certificate
Create a new API Shield mTLS Client Certificate.
POST /zones/{zone_id}/client_certificates - Write
Reactivate Client Certificate
If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.
PATCH /zones/{zone_id}/client_certificates/{client_certificate_id} - Destructive
Replace Hostname Associations
Replace Hostname Associations.
PUT /zones/{zone_id}/certificate_authorities/hostname_associations - Destructive
Revoke Client Certificate
Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.
DELETE /zones/{zone_id}/client_certificates/{client_certificate_id}
Zone Cloud Connector Rules GET
- Read
Rules
Retrieves the Cloud Connector rules configured for a zone. Rules define how traffic is routed to cloud services.
GET /zones/{zone_id}/cloud_connector/rules
Zone Cloud Connector Rules PUT
- Destructive
Put Rules
Updates Cloud Connector rules for a zone, replacing the existing rule configuration.
PUT /zones/{zone_id}/cloud_connector/rules
Content Scanning
- Read
List the Content Scanning custom expressions of a zone.
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.
GET /zones/{zone_id}/content-upload-scan/payloads - Read
Get the Content Scanning status for a zone.
Get the current Content Scanning status for the zone, together with the date the status was last modified.
GET /zones/{zone_id}/content-upload-scan/settings - Write
Disable Content Scanning for a zone.
Disable Content Scanning for a zone. The `cf.waf.content_scan.*` fields are no longer populated, so rules that reference them stop matching.
POST /zones/{zone_id}/content-upload-scan/disable - Write
Enable Content Scanning for a zone.
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.
POST /zones/{zone_id}/content-upload-scan/enable - Write
Create Content Scanning custom expressions for a zone.
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")`.
POST /zones/{zone_id}/content-upload-scan/payloads - Write
Update a Content Scanning custom expression for a zone.
Update the Content Scanning custom expression with the given identifier and return the updated list of expressions.
PATCH /zones/{zone_id}/content-upload-scan/payloads/{expression_id} - Destructive
Delete a Content Scanning custom expression from a zone.
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.
DELETE /zones/{zone_id}/content-upload-scan/payloads/{expression_id} - Destructive
Update the Content Scanning status for a zone.
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.
PUT /zones/{zone_id}/content-upload-scan/settings
CT Alerting
- Read
Get CT Alerting 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.
GET /zones/{zone_id}/ct/alerting - Write
Update CT Alerting 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.
PATCH /zones/{zone_id}/ct/alerting
Custom SSL for a Zone
- Read
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.
GET /zones/{zone_id}/custom_certificates - Read
SSL Configuration Details
Retrieves details for a specific custom SSL certificate, including certificate metadata, bundle method, geographic restrictions, and associated keyless server configuration.
GET /zones/{zone_id}/custom_certificates/{custom_certificate_id} - Write
Create SSL Configuration
Upload a new SSL certificate for a zone.
POST /zones/{zone_id}/custom_certificates - Destructive
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.
PUT /zones/{zone_id}/custom_certificates/prioritize - Destructive
Delete SSL Configuration
Remove a SSL certificate from a zone.
DELETE /zones/{zone_id}/custom_certificates/{custom_certificate_id} - Destructive
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.
PATCH /zones/{zone_id}/custom_certificates/{custom_certificate_id}
Custom CSRs for a Zone
- Read
List Custom CSRs
List all custom Certificate Signing Requests (CSRs) for a zone.
GET /zones/{zone_id}/custom_csrs - Read
Custom CSR Details
Retrieve details for a specific custom Certificate Signing Request (CSR).
GET /zones/{zone_id}/custom_csrs/{custom_csr_id} - Write
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.
POST /zones/{zone_id}/custom_csrs - Destructive
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.
DELETE /zones/{zone_id}/custom_csrs/{custom_csr_id}
Custom Hostname for a Zone
- Read
List Custom Hostnames
List, search, sort, and filter all of your custom hostnames.
GET /zones/{zone_id}/custom_hostnames - Read
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.
GET /zones/{zone_id}/custom_hostnames/quota - Read
Custom Hostname Details
Retrieves detailed information about a specific custom hostname, including SSL certificate status, ownership verification, and origin configuration.
GET /zones/{zone_id}/custom_hostnames/{custom_hostname_id} - Write
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.
POST /zones/{zone_id}/custom_hostnames - Write
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.
PATCH /zones/{zone_id}/custom_hostnames/{custom_hostname_id} - Destructive
Delete Custom Hostname (and any issued SSL certificates)
Permanently deletes a custom hostname and revokes any SSL certificates that were issued for it. This action cannot be undone.
DELETE /zones/{zone_id}/custom_hostnames/{custom_hostname_id} - Destructive
Delete Single Certificate And Key For Custom Hostname
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.
DELETE /zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id} - Destructive
Replace Custom Certificate and Custom Key In 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.
PUT /zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id}
Custom Hostname Fallback Origin for a Zone
- Read
Get Fallback Origin for Custom Hostnames
Retrieves the current fallback origin configuration for custom hostnames on a zone. The fallback origin handles traffic when specific custom hostname origins are unavailable.
GET /zones/{zone_id}/custom_hostnames/fallback_origin - Destructive
Delete Fallback Origin for Custom Hostnames
Removes the fallback origin configuration for custom hostnames on a zone. Custom hostnames without specific origins will no longer have a fallback.
DELETE /zones/{zone_id}/custom_hostnames/fallback_origin - Destructive
Update Fallback Origin for Custom Hostnames
Updates the fallback origin configuration for custom hostnames on a zone. Sets the default origin server for custom hostname traffic.
PUT /zones/{zone_id}/custom_hostnames/fallback_origin
Account-Level Custom Nameservers Usage for a Zone
Custom pages for a zone
- Read
List custom pages
Lists all custom page configurations for a zone.
GET /zones/{zone_id}/custom_pages - Read
Get a custom page
Returns the configuration for a custom page type at the zone level.
GET /zones/{zone_id}/custom_pages/{identifier} - Write
Create a preview token
Creates a signed JWT for previewing a zone-level custom page before it is published.
POST /zones/{zone_id}/custom_pages/preview_tokens - Destructive
Update a custom page
Updates the configuration for a custom page type at the zone level.
PUT /zones/{zone_id}/custom_pages/{identifier}
Custom assets for a zone
- Read
List custom assets
Lists custom assets for a zone.
GET /zones/{zone_id}/custom_pages/assets - Read
Get a custom asset
Returns a custom asset for a zone.
GET /zones/{zone_id}/custom_pages/assets/{asset_name} - Write
Create a custom asset
Creates a custom asset for a zone.
POST /zones/{zone_id}/custom_pages/assets - Destructive
Delete a custom asset
Deletes a custom asset from a zone.
DELETE /zones/{zone_id}/custom_pages/assets/{asset_name} - Destructive
Update a custom asset
Updates a custom asset for a zone.
PUT /zones/{zone_id}/custom_pages/assets/{asset_name}
DCV Delegation
- Read
Retrieve the DCV Delegation unique identifier.
Retrieve the account and zone specific unique identifier used as part of the CNAME target for DCV Delegation.
GET /zones/{zone_id}/dcv_delegation/uuid
DNS Analytics
- Read
Table (deprecated)
Retrieves a list of summarised aggregate metrics over a given time period. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
GET /zones/{zone_id}/dns_analytics/report - Read
By Time (deprecated)
Retrieves a list of aggregate metrics grouped by time interval. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
GET /zones/{zone_id}/dns_analytics/report/bytime
DNS Records for a Zone
- Read
List DNS Records
List, search, sort, and filter a zones' DNS records.
GET /zones/{zone_id}/dns_records - Read
Export DNS Records
You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information.
GET /zones/{zone_id}/dns_records/export - Read
List Scanned DNS Records
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.
GET /zones/{zone_id}/dns_records/scan/review - Read
Get DNS Record Usage
Get the current DNS record usage for a zone, including the number of records and the quota limit.
GET /zones/{zone_id}/dns_records/usage - Read
DNS Record Details
Retrieves details for a specific DNS record in the zone.
GET /zones/{zone_id}/dns_records/{dns_record_id} - Write
Create DNS Record
Create a new DNS record for a zone. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.
POST /zones/{zone_id}/dns_records - Write
Import DNS Records
You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information.
POST /zones/{zone_id}/dns_records/import - Write
Scan DNS Records (deprecated)
Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.
POST /zones/{zone_id}/dns_records/scan - Write
Trigger DNS Record 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.
POST /zones/{zone_id}/dns_records/scan/trigger - Write
Update DNS Record
Update an existing DNS record. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.
PATCH /zones/{zone_id}/dns_records/{dns_record_id} - Destructive
Batch DNS Records
Send a Batch of DNS Record API calls to be executed together. Notes: - Although Cloudflare will execute the batched operations in a single database transaction, Cloudflare's distributed KV store must treat each record change as a single key-value pair. This means that the propagation of changes is not atomic. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/batch-record-changes/ "Batch DNS records") for more information. - The operations you specify within the /batch request body are always executed in the following order: - Deletes - Patches - Puts - Posts
POST /zones/{zone_id}/dns_records/batch - Destructive
Review Scanned DNS Records
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.
POST /zones/{zone_id}/dns_records/scan/review - Destructive
Delete DNS Record
Permanently removes a DNS record from the zone.
DELETE /zones/{zone_id}/dns_records/{dns_record_id} - Destructive
Overwrite DNS Record
Overwrite an existing DNS record. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.
PUT /zones/{zone_id}/dns_records/{dns_record_id}
DNS Settings for a Zone
- Read
Show DNS Settings
Show DNS settings for a zone
GET /zones/{zone_id}/dns_settings - Write
Update DNS Settings
Update DNS settings for a zone
PATCH /zones/{zone_id}/dns_settings
DNSSEC
- Read
DNSSEC Details
Details about DNSSEC status and configuration.
GET /zones/{zone_id}/dnssec - Read
List DNSSEC ZSKs
List the Zone Signing Keys (ZSKs) that DNSSEC uses for the zone.
GET /zones/{zone_id}/dnssec/zsk - Write
Edit DNSSEC Status
Enable or disable DNSSEC.
PATCH /zones/{zone_id}/dnssec - Destructive
Delete DNSSEC records
Delete DNSSEC.
DELETE /zones/{zone_id}/dnssec
Email Auth
- Read
Get DMARC Report Status
Retrieves the current DMARC report configuration and status for a zone. Returns the RUA prefix, enabled status, approved sources, and DNS records.
GET /zones/{zone_id}/email/auth/dmarc-reports - Read
Inspect SPF Record
Inspects a specific SPF TXT record and returns a parsed tree structure in the spflimit-worker format. The record ID must be provided via the `id` query parameter. Returns a recursive tree showing: - Parsed components with their qualifiers and types - Nested includes recursively resolved within components - Per-component and total lookup counts - Detailed error information with context
GET /zones/{zone_id}/email/auth/spf/inspect - Write
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.
PATCH /zones/{zone_id}/email/auth/dmarc-reports
Email Routing settings
- Read
Get Email Routing settings
Get information about the settings for your Email Routing zone.
GET /zones/{zone_id}/email/routing - Read
Email Routing - DNS settings
Show the DNS records needed to configure your Email Routing zone.
GET /zones/{zone_id}/email/routing/dns - Write
Update Email Routing settings
Update the settings for your Email Routing zone.
PATCH /zones/{zone_id}/email/routing - Write
Unlock Email Routing DNS records
Unlock MX Records previously locked by Email Routing.
PATCH /zones/{zone_id}/email/routing/dns - Write
Enable Email Routing
Enable your Email Routing zone. Add and lock the necessary MX and SPF records.
POST /zones/{zone_id}/email/routing/dns - Write
Enable Email Routing (deprecated)
Enable you Email Routing zone. Add and lock the necessary MX and SPF records.
POST /zones/{zone_id}/email/routing/enable - Write
Unlock Email Routing (deprecated)
Unlock MX records previously locked by Email Routing. Deprecated - use PATCH /zones/{zone_id}/email/routing/dns instead.
POST /zones/{zone_id}/email/routing/unlock - Destructive
Apply Email Routing settings
Apply the provided settings to your Email Routing zone. Omitted settings retain their current values, as with PATCH.
PUT /zones/{zone_id}/email/routing - Destructive
Disable Email Routing (deprecated)
Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.
POST /zones/{zone_id}/email/routing/disable - Destructive
Disable Email Routing
Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.
DELETE /zones/{zone_id}/email/routing/dns
Email Sending subdomains
- Read
List sending subdomains
Lists all sending-enabled subdomains for the zone.
GET /zones/{zone_id}/email/sending/subdomains - Read
Preview sending subdomain DNS
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.
POST /zones/{zone_id}/email/sending/subdomains/preview - Read
Get a sending subdomain
Gets information for a specific sending subdomain.
GET /zones/{zone_id}/email/sending/subdomains/{subdomain_id} - Read
Get sending subdomain DNS records
Returns the expected DNS records for a sending subdomain.
GET /zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns - Read
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.
GET /zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns/status - Read
Get sending subdomain complaint count
Returns the matched complaint count for a sending subdomain in a half-open time window of up to seven days.
GET /zones/{zone_id}/email/sending/subdomains/{subdomain_id}/reputation/complaints - Write
Create a 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.<base>` return path.
POST /zones/{zone_id}/email/sending/subdomains - Write
Update a sending subdomain
Updates the activity-log preview preference for a sending subdomain.
PATCH /zones/{zone_id}/email/sending/subdomains/{subdomain_id} - Write
Fix sending subdomain DNS records
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.
POST /zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns - Destructive
Delete a sending subdomain
Disables sending on a subdomain and removes its DNS records. If routing is still active on the subdomain, only sending is disabled.
DELETE /zones/{zone_id}/email/sending/subdomains/{subdomain_id}
Zone Entitlements
- Read
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.
GET /zones/{zone_id}/entitlements
Zone Environments
- Read
List zone environments
Lists configured environments for a zone.
GET /zones/{zone_id}/environments - Write
Partially update zone environments
Applies partial updates to zone environments.
PATCH /zones/{zone_id}/environments - Write
Create zone environments
Creates environments for a zone.
POST /zones/{zone_id}/environments - Write
Roll back zone environment
Rolls a zone environment back to its previous version.
POST /zones/{zone_id}/environments/{environment_id}/rollback - Destructive
Upsert zone environments
Replaces the full environment configuration for a zone.
PUT /zones/{zone_id}/environments - Destructive
Delete zone environment
Deletes a zone environment by reference identifier.
DELETE /zones/{zone_id}/environments/{environment_id}
Filters
- Read
List filters (deprecated)
Fetches filters in a zone. You can filter the results using several optional parameters.
GET /zones/{zone_id}/filters - Read
Get a filter (deprecated)
Fetches the details of a filter.
GET /zones/{zone_id}/filters/{filter_id} - Write
Create filters (deprecated)
Creates one or more filters.
POST /zones/{zone_id}/filters - Destructive
Delete filters (deprecated)
Deletes one or more existing filters.
DELETE /zones/{zone_id}/filters - Destructive
Update filters (deprecated)
Updates one or more existing filters.
PUT /zones/{zone_id}/filters - Destructive
Delete a filter (deprecated)
Deletes an existing filter.
DELETE /zones/{zone_id}/filters/{filter_id} - Destructive
Update a filter (deprecated)
Updates an existing filter.
PUT /zones/{zone_id}/filters/{filter_id}
IP Access rules for a zone
- Read
List IP Access rules
Fetches IP Access rules of a zone. You can filter the results using several optional parameters.
GET /zones/{zone_id}/firewall/access_rules/rules - Write
Create an IP Access rule
Creates a new IP Access rule for a zone. Note: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate.
POST /zones/{zone_id}/firewall/access_rules/rules - Write
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.
PATCH /zones/{zone_id}/firewall/access_rules/rules/{rule_id} - Destructive
Delete an IP Access rule
Deletes an IP Access rule defined at the zone level. Optionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner.
DELETE /zones/{zone_id}/firewall/access_rules/rules/{rule_id}
Zone Lockdown
- Read
List Zone Lockdown rules
Fetches Zone Lockdown rules. You can filter the results using several optional parameters.
GET /zones/{zone_id}/firewall/lockdowns - Read
Get a Zone Lockdown rule
Fetches the details of a Zone Lockdown rule.
GET /zones/{zone_id}/firewall/lockdowns/{lock_downs_id} - Write
Create a Zone Lockdown rule
Creates a new Zone Lockdown rule.
POST /zones/{zone_id}/firewall/lockdowns - Destructive
Delete a Zone Lockdown rule
Deletes an existing Zone Lockdown rule.
DELETE /zones/{zone_id}/firewall/lockdowns/{lock_downs_id} - Destructive
Update a Zone Lockdown rule
Updates an existing Zone Lockdown rule.
PUT /zones/{zone_id}/firewall/lockdowns/{lock_downs_id}
Payload logging keys for a zone
- Read
Get the payload logging key
Fetches the public key that payload logging uses to encrypt matched payloads for the zone.
GET /zones/{zone_id}/firewall/payload_logging/key - Destructive
Delete the payload logging key
Deletes the payload logging public key of the zone.
DELETE /zones/{zone_id}/firewall/payload_logging/key - Destructive
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.
PUT /zones/{zone_id}/firewall/payload_logging/key
Firewall rules
- Read
List firewall rules (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Fetches firewall rules in a zone. You can filter the results using several optional parameters.
GET /zones/{zone_id}/firewall/rules - Read
Get a firewall rule (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Fetches the details of a firewall rule.
GET /zones/{zone_id}/firewall/rules/{rule_id} - Write
Update priority of firewall rules (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Updates the priority of existing firewall rules.
PATCH /zones/{zone_id}/firewall/rules - Write
Create firewall rules (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Create one or more firewall rules.
POST /zones/{zone_id}/firewall/rules - Write
Update priority of a firewall rule (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Updates the priority of an existing firewall rule.
PATCH /zones/{zone_id}/firewall/rules/{rule_id} - Destructive
Delete firewall rules (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Deletes existing firewall rules.
DELETE /zones/{zone_id}/firewall/rules - Destructive
Update firewall rules (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Updates one or more existing firewall rules.
PUT /zones/{zone_id}/firewall/rules - Destructive
Delete a firewall rule (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Deletes an existing firewall rule.
DELETE /zones/{zone_id}/firewall/rules/{rule_id} - Destructive
Update a firewall rule (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Updates an existing firewall rule.
PUT /zones/{zone_id}/firewall/rules/{rule_id}
User Agent Blocking rules
- Read
List User Agent Blocking rules
Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.
GET /zones/{zone_id}/firewall/ua_rules - Read
Get a User Agent Blocking rule
Fetches the details of a User Agent Blocking rule.
GET /zones/{zone_id}/firewall/ua_rules/{ua_rule_id} - Write
Create a User Agent Blocking rule
Creates a new User Agent Blocking rule in a zone.
POST /zones/{zone_id}/firewall/ua_rules - Destructive
Delete a User Agent Blocking rule
Deletes an existing User Agent Blocking rule.
DELETE /zones/{zone_id}/firewall/ua_rules/{ua_rule_id} - Destructive
Update a User Agent Blocking rule
Updates an existing User Agent Blocking rule.
PUT /zones/{zone_id}/firewall/ua_rules/{ua_rule_id}
WAF overrides
- Read
List WAF overrides (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Previously fetched the URI-based WAF overrides in a zone.
GET /zones/{zone_id}/firewall/waf/overrides - Read
Get a WAF override (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Previously fetched the details of a URI-based WAF override.
GET /zones/{zone_id}/firewall/waf/overrides/{overrides_id} - Write
Create a WAF override (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Previously created a URI-based WAF override for a zone.
POST /zones/{zone_id}/firewall/waf/overrides - Destructive
Delete a WAF override (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Previously deleted an existing URI-based WAF override.
DELETE /zones/{zone_id}/firewall/waf/overrides/{overrides_id} - Destructive
Update WAF override (deprecated)
**This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Previously updated an existing URI-based WAF override.
PUT /zones/{zone_id}/firewall/waf/overrides/{overrides_id}
WAF packages
- Read
List WAF packages (deprecated)
Fetches WAF packages for a zone. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
GET /zones/{zone_id}/firewall/waf/packages - Read
Get a WAF package (deprecated)
Fetches the details of a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
GET /zones/{zone_id}/firewall/waf/packages/{package_id} - Write
Update a WAF package (deprecated)
Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
PATCH /zones/{zone_id}/firewall/waf/packages/{package_id}
WAF rule groups
- Read
List WAF rule groups (deprecated)
Fetches the WAF rule groups in a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
GET /zones/{zone_id}/firewall/waf/packages/{package_id}/groups - Read
Get a WAF rule group (deprecated)
Fetches the details of a WAF rule group. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
GET /zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id} - Write
Update a WAF rule group (deprecated)
Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
PATCH /zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}
WAF rules
- Read
List WAF rules (deprecated)
Fetches WAF rules in a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
GET /zones/{zone_id}/firewall/waf/packages/{package_id}/rules - Read
Get a WAF rule (deprecated)
Fetches the details of a WAF rule in a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
GET /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id} - Write
Update a WAF rule (deprecated)
Updates a WAF rule. You can only update the mode/action of the rule. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
PATCH /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}
Fraud Detection
- Read
Get Fraud Detection Settings
Retrieve Fraud Detection settings for a zone.
GET /zones/{zone_id}/fraud_detection/settings - Destructive
Update Fraud Detection Settings
Update Fraud Detection settings for a zone. Notes on `username_expressions` behavior: - If omitted or set to null, expressions are not modified. - If provided as an empty array `[]`, all expressions will be cleared.
PUT /zones/{zone_id}/fraud_detection/settings
Health Checks
- Read
List Health Checks
List configured health checks.
GET /zones/{zone_id}/healthchecks - Read
Health Check Preview Details
Fetch a single configured health check preview.
GET /zones/{zone_id}/healthchecks/preview/{healthcheck_id} - Read
Health Check Details
Fetch a single configured health check.
GET /zones/{zone_id}/healthchecks/{healthcheck_id} - Read
List Health Checks
List configured health checks.
GET /zones/{zone_id}/smart_shield/healthchecks - Read
Health Check Details
Fetch a single configured health check.
GET /zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id} - Write
Create Health Check
Create a new health check.
POST /zones/{zone_id}/healthchecks - Write
Create Preview Health Check
Create a new preview health check.
POST /zones/{zone_id}/healthchecks/preview - Write
Patch Health Check
Patch a configured health check.
PATCH /zones/{zone_id}/healthchecks/{healthcheck_id} - Write
Create Health Check
Create a new health check.
POST /zones/{zone_id}/smart_shield/healthchecks - Write
Patch Health Check
Patch a configured health check.
PATCH /zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id} - Destructive
Delete Preview Health Check
Delete a health check.
DELETE /zones/{zone_id}/healthchecks/preview/{healthcheck_id} - Destructive
Delete Health Check
Delete a health check.
DELETE /zones/{zone_id}/healthchecks/{healthcheck_id} - Destructive
Update Health Check
Update a configured health check.
PUT /zones/{zone_id}/healthchecks/{healthcheck_id} - Destructive
Delete Health Check
Delete a health check.
DELETE /zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id} - Destructive
Update Health Check
Update a configured health check.
PUT /zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id}
Zone Holds
- Read
Get Zone Hold
Retrieve whether the zone is subject to a zone hold, and metadata about the hold.
GET /zones/{zone_id}/hold - Read
Get Zone Hold by Zone Name
Retrieve whether a given hostname is subject to a zone hold, and metadata about the hold. This endpoint checks whether the given hostname (or any of its ancestor domains) is blocked by an active zone hold. If a hold with `include_subdomains` is active on an ancestor domain, that hold is returned. This endpoint is used internally by SSL/COMS to check hold status during zone activation.
GET /zones/{zone_id}/hold/{zone_name} - Write
Update Zone Hold
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.
PATCH /zones/{zone_id}/hold - Write
Create Zone Hold
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.
POST /zones/{zone_id}/hold - Destructive
Remove Zone Hold
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.
DELETE /zones/{zone_id}/hold
Per Hostname TLS Settings
- Read
List TLS setting for hostnames
List the requested TLS setting for the hostnames under this zone.
GET /zones/{zone_id}/hostnames/settings/{setting_id} - Read
Get TLS setting for hostname
Get the requested TLS setting for the hostname.
GET /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname} - Destructive
Delete TLS setting for hostname
Delete the tls setting value for the hostname.
DELETE /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname} - Destructive
Edit TLS setting for hostname
Update the tls setting value for the hostname.
PUT /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}
Images
- Read
Get transformation flows
Get the current transformation flows configuration for a zone.
GET /zones/{zone_id}/images/v1/flows - Destructive
Update transformation flows
Replace the entire transformation flows configuration for a zone.
PUT /zones/{zone_id}/images/v1/flows
Keyless SSL for a Zone
- Read
List Keyless SSL Configurations
List all Keyless SSL configurations for a given zone.
GET /zones/{zone_id}/keyless_certificates - Read
Get Keyless SSL Configuration
Get details for one Keyless SSL configuration.
GET /zones/{zone_id}/keyless_certificates/{keyless_certificate_id} - Write
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.
POST /zones/{zone_id}/keyless_certificates - Write
Edit Keyless SSL Configuration
This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port.
PATCH /zones/{zone_id}/keyless_certificates/{keyless_certificate_id} - Destructive
Delete Keyless SSL Configuration
Removes a Keyless SSL configuration. SSL connections will no longer use the keyless server for cryptographic operations.
DELETE /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}
Leaked Credential Checks
- Read
Get the Leaked Credential Checks status for a zone.
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.
GET /zones/{zone_id}/leaked-credential-checks - Read
List the custom detection locations of a zone.
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.
GET /zones/{zone_id}/leaked-credential-checks/detections - Read
Get a custom detection location of a zone.
Get the username and password expressions of a single user-defined detection location, identified by its detection ID.
GET /zones/{zone_id}/leaked-credential-checks/detections/{detection_id} - Write
Update the Leaked Credential Checks status for a zone.
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.
POST /zones/{zone_id}/leaked-credential-checks - Write
Create a custom detection location for a zone.
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.
POST /zones/{zone_id}/leaked-credential-checks/detections - Destructive
Delete a custom detection location from a zone.
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.
DELETE /zones/{zone_id}/leaked-credential-checks/detections/{detection_id} - Destructive
Update a custom detection location of a zone.
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.
PUT /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}
Load Balancers
- Read
List Load Balancers
List configured load balancers.
GET /zones/{zone_id}/load_balancers - Read
Load Balancer Details
Fetch a single configured load balancer.
GET /zones/{zone_id}/load_balancers/{load_balancer_id} - Write
Create Load Balancer
Create a new load balancer.
POST /zones/{zone_id}/load_balancers - Destructive
Delete Load Balancer
Delete a configured load balancer.
DELETE /zones/{zone_id}/load_balancers/{load_balancer_id} - Destructive
Patch Load Balancer
Apply changes to an existing load balancer, overwriting the supplied properties.
PATCH /zones/{zone_id}/load_balancers/{load_balancer_id} - Destructive
Update Load Balancer
Update a configured load balancer.
PUT /zones/{zone_id}/load_balancers/{load_balancer_id}
Logpush jobs for a zone
- Read
List 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.
GET /zones/{zone_id}/logpush/datasets/{dataset_id}/fields - Read
List Logpush jobs for a dataset
Lists Logpush jobs for a zone for a dataset.
GET /zones/{zone_id}/logpush/datasets/{dataset_id}/jobs - Read
List Logpush jobs
Lists Logpush jobs for a zone.
GET /zones/{zone_id}/logpush/jobs - Read
Get Logpush job details
Gets the details of a Logpush job.
GET /zones/{zone_id}/logpush/jobs/{job_id} - Read
Get ownership challenge
Gets a new ownership challenge sent to your destination.
POST /zones/{zone_id}/logpush/ownership - Read
Validate ownership challenge
Validates ownership challenge of the destination.
POST /zones/{zone_id}/logpush/ownership/validate - Read
Validate destination
Validates destination.
POST /zones/{zone_id}/logpush/validate/destination - Read
Check destination exists
Checks if there is an existing job with a destination.
POST /zones/{zone_id}/logpush/validate/destination/exists - Read
Validate origin
Validates logpull origin with logpull_options.
POST /zones/{zone_id}/logpush/validate/origin - Write
Create Logpush job
Creates a new Logpush job for a zone.
POST /zones/{zone_id}/logpush/jobs - Destructive
Delete Logpush job
Deletes a Logpush job.
DELETE /zones/{zone_id}/logpush/jobs/{job_id} - Destructive
Update Logpush job
Updates a Logpush job.
PUT /zones/{zone_id}/logpush/jobs/{job_id}
Instant Logs jobs for a zone
- Read
List Instant Logs jobs
Lists Instant Logs jobs for a zone.
GET /zones/{zone_id}/logpush/edge/jobs - Write
Create Instant Logs job
Creates a new Instant Logs job for a zone.
POST /zones/{zone_id}/logpush/edge/jobs
Logs Received
- Read
Get log retention flag
Gets log retention flag for Logpull API.
GET /zones/{zone_id}/logs/control/retention/flag - Read
Get logs RayIDs
The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).
GET /zones/{zone_id}/logs/rayids/{ray_id} - Read
Get 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.
GET /zones/{zone_id}/logs/received - Read
List fields
Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.
GET /zones/{zone_id}/logs/received/fields - Write
Update log retention flag
Updates log retention flag for Logpull API.
POST /zones/{zone_id}/logs/control/retention/flag
Managed Transforms
- Read
List Managed Transforms
Fetches a list of all Managed Transforms.
GET /zones/{zone_id}/managed_headers - Write
Update Managed Transforms
Updates the status of one or more Managed Transforms.
PATCH /zones/{zone_id}/managed_headers - Destructive
Delete Managed Transforms
Disables all Managed Transforms.
DELETE /zones/{zone_id}/managed_headers
Observability
- Read
View zone trace rules
Retrieve the ordered sampling overrides for a zone's managed Cloudflare Traces ruleset.
GET /zones/{zone_id}/observability/tracing/rules - Read
View zone tracing settings
Retrieve the zone-level Cloudflare Traces settings.
GET /zones/{zone_id}/observability/tracing/settings - Write
Update zone tracing settings
Update the zone-level Cloudflare Traces settings.
PATCH /zones/{zone_id}/observability/tracing/settings - Destructive
Delete zone trace rules
Delete every sampling override from a zone's managed Cloudflare Traces ruleset.
DELETE /zones/{zone_id}/observability/tracing/rules - Destructive
Replace zone trace rules
Replace all sampling overrides in a zone's managed Cloudflare Traces ruleset. Rules are evaluated in the supplied order.
PUT /zones/{zone_id}/observability/tracing/rules - Destructive
Reset zone tracing settings
Reset the zone-level Cloudflare Traces settings to their defaults while preserving the sampling rules.
DELETE /zones/{zone_id}/observability/tracing/settings
Zone Level Authenticated Origin Pulls
- Read
List Certificates
Lists all client certificates configured for zone-level authenticated origin pulls.
GET /zones/{zone_id}/origin_tls_client_auth - Read
Get Enablement Setting for Zone
Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.
GET /zones/{zone_id}/origin_tls_client_auth/settings - Read
Get Certificate Details
Retrieves details for a specific client certificate used in zone-level authenticated origin pulls.
GET /zones/{zone_id}/origin_tls_client_auth/{certificate_id} - Write
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.
POST /zones/{zone_id}/origin_tls_client_auth - Destructive
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.
PUT /zones/{zone_id}/origin_tls_client_auth/settings - Destructive
Delete Certificate
Removes a client certificate used for zone-level authenticated origin pulls.
DELETE /zones/{zone_id}/origin_tls_client_auth/{certificate_id}
Per hostname Authenticated Origin Pull
- Read
List Hostname Associations
List certificate ID - hostname associations for the given zone. Shows which hostnames are associated to which certificates for authenticated origin pulls.
GET /zones/{zone_id}/origin_tls_client_auth/hostnames - Read
List Certificates
Lists all client certificates configured for per-hostname authenticated origin pulls on the zone.
GET /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates - Read
Get the Hostname Client Certificate
Get the certificate by ID to be used for client authentication on a hostname.
GET /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id} - Read
Get the Hostname Status for Client Authentication
Retrieves the client certificate authentication status for a specific hostname, showing whether authenticated origin pulls are enabled.
GET /zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname} - Write
Upload a Hostname Client Certificate
Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.
POST /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates - Destructive
Enable or Disable a Hostname for Client Authentication
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.
PUT /zones/{zone_id}/origin_tls_client_auth/hostnames - Destructive
Delete Hostname Client Certificate
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.
DELETE /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}
Client Side Security
- Read
Get client-side security settings
Returns the client-side security product enablement status and reporting behaviors.
GET /zones/{zone_id}/page_shield - Read
List detected connections
Lists outbound connections made by webpages in the zone.
GET /zones/{zone_id}/page_shield/connections - Read
Get a detected connection
Returns a webpage connection detected on the zone by connection ID.
GET /zones/{zone_id}/page_shield/connections/{connection_id} - Read
List detected cookies
Lists cookies detected on the zone.
GET /zones/{zone_id}/page_shield/cookies - Read
Get a detected cookie
Returns a cookie detected on the zone by cookie ID.
GET /zones/{zone_id}/page_shield/cookies/{cookie_id} - Read
List content security rules
Lists content security rules configured for the zone.
GET /zones/{zone_id}/page_shield/policies - Read
Get a content security rule
Returns a content security rule by ID.
GET /zones/{zone_id}/page_shield/policies/{policy_id} - Read
List detected scripts
Lists scripts detected on webpages in the zone, with filtering and pagination.
GET /zones/{zone_id}/page_shield/scripts - Read
Get a detected script
Returns a script detected on the zone by script ID.
GET /zones/{zone_id}/page_shield/scripts/{script_id} - Write
Create a content security rule
Creates a rule that applies a client-side security action when its filter expression matches.
POST /zones/{zone_id}/page_shield/policies - Destructive
Update client-side security settings
Updates client-side security enablement and reporting behaviors for the zone.
PUT /zones/{zone_id}/page_shield - Destructive
Delete a content security rule
Permanently deletes a content security rule by ID.
DELETE /zones/{zone_id}/page_shield/policies/{policy_id} - Destructive
Update a content security rule
Updates the description, action, expression, enabled state, and policy value for a content security rule.
PUT /zones/{zone_id}/page_shield/policies/{policy_id}
Page Rules
- Read
List Page Rules
Fetches Page Rules in a zone.
GET /zones/{zone_id}/pagerules - Read
Get a Page Rule
Fetches the details of a Page Rule.
GET /zones/{zone_id}/pagerules/{pagerule_id} - Write
Create a Page Rule
Creates a new Page Rule.
POST /zones/{zone_id}/pagerules - Write
Edit a Page Rule
Updates one or more fields of an existing Page Rule.
PATCH /zones/{zone_id}/pagerules/{pagerule_id} - Destructive
Delete a Page Rule
Deletes an existing Page Rule.
DELETE /zones/{zone_id}/pagerules/{pagerule_id} - Destructive
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.
PUT /zones/{zone_id}/pagerules/{pagerule_id}
Available Page Rules settings
- Read
List available Page Rules settings (deprecated)
Returns a list of settings (and their details) that Page Rules can apply to matching requests.
GET /zones/{zone_id}/pagerules/settings
Precursor
- Read
Get Zone Precursor Config
Retrieve a zone's Precursor configuration: the detection `mode`, whether to `show_interstitial`, and the ordered list of `rules`.
GET /zones/{zone_id}/precursor - Destructive
Update Zone Precursor Config
Updates the Precursor configuration for a zone. `mode` controls whether Precursor detection is off, monitoring, or armed. `show_interstitial` controls the zone-level response when armed. `rules` is the ordered list of overrides for matching requests. This is a partial update: only the fields present in the request body are changed. - Sending an empty array (`[]`) clears all rules. - At least one of `mode`, `show_interstitial`, or `rules` must be present; an empty body (`{}`) is rejected with `400`. - Rule `id` is read-only (assigned by Cloudflare) and ignored on input. - Rule `show_interstitial` is required and controls the response for requests that match that rule. - Rule `expression` is limited to 4000 characters. The limit applies to each rule individually, not to the combined size of all rules.
PUT /zones/{zone_id}/precursor
Rate Limiting Analytics
- Read
Get Rate Limiting Analytics (deprecated)
Returns rate limiting analytics for a zone over the specified time period. The time period divides into time segments of a given length. Each segment contains total action counts and action counts broken down by colo.
GET /zones/{zone_id}/rate_limit_analytics
Rate limits for a zone
- Read
List rate limits (deprecated)
**Deprecated**: This endpoint returns 410 Gone. Please use the Rulesets API instead.
GET /zones/{zone_id}/rate_limits - Read
Get a rate limit (deprecated)
**Deprecated**: This endpoint returns 410 Gone. Please use the Rulesets API instead.
GET /zones/{zone_id}/rate_limits/{rate_limit_id} - Write
Create a rate limit (deprecated)
**Deprecated**: This endpoint returns 410 Gone. Please use the Rulesets API instead.
POST /zones/{zone_id}/rate_limits - Destructive
Delete a rate limit (deprecated)
**Deprecated**: This endpoint returns 410 Gone. Please use the Rulesets API instead.
DELETE /zones/{zone_id}/rate_limits/{rate_limit_id} - Destructive
Update a rate limit (deprecated)
**Deprecated**: This endpoint returns 410 Gone. Please use the Rulesets API instead.
PUT /zones/{zone_id}/rate_limits/{rate_limit_id}
Zone Rulesets
- Read
List zone rulesets
Fetches all rulesets at the zone level.
GET /zones/{zone_id}/rulesets - Read
Get a zone entry point ruleset
Fetches the latest version of the zone entry point ruleset for a given phase.
GET /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint - Read
List a zone entry point ruleset's versions
Fetches the versions of a zone entry point ruleset.
GET /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions - Read
Get a zone entry point ruleset version
Fetches a specific version of a zone entry point ruleset.
GET /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version} - Read
Get a zone ruleset
Fetches the latest version of a zone ruleset.
GET /zones/{zone_id}/rulesets/{ruleset_id} - Read
List a zone ruleset's versions
Fetches the versions of a zone ruleset.
GET /zones/{zone_id}/rulesets/{ruleset_id}/versions - Read
Get a zone ruleset version
Fetches a specific version of a zone ruleset.
GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version} - Read
List a zone ruleset version's rules by tag
Fetches the rules of a managed zone ruleset version for a given tag.
GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag} - Write
Create a zone ruleset
Creates a ruleset at the zone level.
POST /zones/{zone_id}/rulesets - Write
Create a zone ruleset rule
Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.
POST /zones/{zone_id}/rulesets/{ruleset_id}/rules - Write
Update a zone ruleset rule
Updates an existing rule in a zone ruleset.
PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id} - Destructive
Update a zone entry point ruleset
Updates a zone entry point ruleset, creating a new version.
PUT /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint - Destructive
Delete a zone ruleset
Deletes all versions of an existing zone ruleset.
DELETE /zones/{zone_id}/rulesets/{ruleset_id} - Destructive
Update a zone ruleset
Updates a zone ruleset, creating a new version.
PUT /zones/{zone_id}/rulesets/{ruleset_id} - Destructive
Delete a zone ruleset rule
Deletes an existing rule from a zone ruleset.
DELETE /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id} - Destructive
Delete a zone ruleset version
Deletes an existing version of a zone ruleset.
DELETE /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}
Schema Validation
- Read
List all uploaded schemas
Lists all OpenAPI schemas uploaded to API Security.
GET /zones/{zone_id}/schema_validation/schemas - Read
List hosts covered by uploaded schemas
Lists all unique hosts found in uploaded OpenAPI schemas for the zone.
GET /zones/{zone_id}/schema_validation/schemas/hosts - Read
Get details of a schema
Gets the contents and metadata of a specific OpenAPI schema uploaded to API Security.
GET /zones/{zone_id}/schema_validation/schemas/{schema_id} - Read
Retrieve all operations from the schema
Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations.
GET /zones/{zone_id}/schema_validation/schemas/{schema_id}/operations - Write
Upload a schema
Uploads an OpenAPI schema that defines expected request formats for API operations.
POST /zones/{zone_id}/schema_validation/schemas - Write
Set schema validation state
Enables or disables validation for an uploaded OpenAPI schema without changing the schema document.
PATCH /zones/{zone_id}/schema_validation/schemas/{schema_id} - Destructive
Delete a schema
Permanently removes an uploaded OpenAPI schema from API Security. Operations using this schema will lose their validation rules.
DELETE /zones/{zone_id}/schema_validation/schemas/{schema_id}
Schema Validation Settings
- Read
Get global schema validation settings
Retrieves the current global schema validation settings for a zone.
GET /zones/{zone_id}/schema_validation/settings - Read
List per-operation schema validation settings
Lists per-operation schema validation settings configured for the zone.
GET /zones/{zone_id}/schema_validation/settings/operations - Read
Get per-operation schema validation setting
Retrieves the schema validation settings configured for a specific API operation.
GET /zones/{zone_id}/schema_validation/settings/operations/{operation_id} - Destructive
Edit global schema validation settings
Partially updates global schema validation settings for a zone using PATCH semantics.
PATCH /zones/{zone_id}/schema_validation/settings - Destructive
Update global schema validation settings
Fully updates global schema validation settings for a zone, replacing existing configuration.
PUT /zones/{zone_id}/schema_validation/settings - Destructive
Bulk edit per-operation schema validation settings
Updates schema validation settings for multiple API operations in a single request. Efficient for applying consistent validation rules across endpoints.
PATCH /zones/{zone_id}/schema_validation/settings/operations - Destructive
Delete per-operation schema validation setting
Removes custom schema validation settings for a specific API operation, reverting to zone-level defaults.
DELETE /zones/{zone_id}/schema_validation/settings/operations/{operation_id} - Destructive
Update per-operation schema validation setting
Fully updates schema validation settings for a specific API operation.
PUT /zones/{zone_id}/schema_validation/settings/operations/{operation_id}
Secondary DNS (Secondary Zone)
- Read
Secondary Zone Configuration Details
Get secondary zone configuration for incoming zone transfers.
GET /zones/{zone_id}/secondary_dns/incoming - Write
Force AXFR
Sends AXFR zone transfer request to primary nameserver(s).
POST /zones/{zone_id}/secondary_dns/force_axfr - Write
Create Secondary Zone Configuration
Create secondary zone configuration for incoming zone transfers.
POST /zones/{zone_id}/secondary_dns/incoming - Destructive
Delete Secondary Zone Configuration
Delete secondary zone configuration for incoming zone transfers.
DELETE /zones/{zone_id}/secondary_dns/incoming - Destructive
Update Secondary Zone Configuration
Update secondary zone configuration for incoming zone transfers.
PUT /zones/{zone_id}/secondary_dns/incoming
Secondary DNS (Primary Zone)
- Read
Primary Zone Configuration Details
Get primary zone configuration for outgoing zone transfers.
GET /zones/{zone_id}/secondary_dns/outgoing - Read
Get Outgoing Zone Transfer Status
Get primary zone transfer status.
GET /zones/{zone_id}/secondary_dns/outgoing/status - Write
Create Primary Zone Configuration
Create primary zone configuration for outgoing zone transfers.
POST /zones/{zone_id}/secondary_dns/outgoing - Write
Enable Outgoing Zone Transfers
Enable outgoing zone transfers for primary zone.
POST /zones/{zone_id}/secondary_dns/outgoing/enable - Destructive
Delete Primary Zone Configuration
Delete primary zone configuration for outgoing zone transfers.
DELETE /zones/{zone_id}/secondary_dns/outgoing - Destructive
Update Primary Zone Configuration
Update primary zone configuration for outgoing zone transfers.
PUT /zones/{zone_id}/secondary_dns/outgoing - Destructive
Disable Outgoing Zone Transfers
Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.
POST /zones/{zone_id}/secondary_dns/outgoing/disable - Destructive
Force DNS NOTIFY
Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.
POST /zones/{zone_id}/secondary_dns/outgoing/force_notify
Security.txt
- Read
Retrieves security.txt
Retrieves the current security.txt file configuration for a zone, used for security vulnerability reporting.
GET /zones/{zone_id}/security-center/securitytxt - Destructive
Deletes security.txt
Removes the security.txt file configuration for a zone. The /.well-known/security.txt endpoint will no longer be served.
DELETE /zones/{zone_id}/security-center/securitytxt - Destructive
Updates security.txt
Updates the security.txt file configuration for a zone, which provides security researchers with vulnerability reporting information.
PUT /zones/{zone_id}/security-center/securitytxt
Zone Settings
- Read
Get all zone settings (deprecated)
Available settings for your user in relation to a zone.
GET /zones/{zone_id}/settings - Read
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.
GET /zones/{zone_id}/settings/aegis - Read
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.
GET /zones/{zone_id}/settings/automatic_platform_optimization - Read
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.
GET /zones/{zone_id}/settings/binary_ast - Read
Get Cloudflare 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.
GET /zones/{zone_id}/settings/fonts - Read
Get HTTP/2 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.
GET /zones/{zone_id}/settings/h2_prioritization - Read
Get Image Transformations setting
Gets the Image Transformations setting for a zone. Accepted values are `off`, `on`, `open`, and `latest`.
GET /zones/{zone_id}/settings/image_resizing - Read
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.
GET /zones/{zone_id}/settings/origin_h2_max_streams - Read
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](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1".
GET /zones/{zone_id}/settings/origin_max_http_version - Read
Get Cloudflare 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.
GET /zones/{zone_id}/settings/speed_brain - Read
Get Image 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.
GET /zones/{zone_id}/settings/transformations_allowed_origins - Read
Get Image 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.
GET /zones/{zone_id}/settings/transformations_c2pa - Read
Get Transformations configuration
Returns the combined Transformations configuration for a zone, including the transformations toggle, allowed origins, and C2PA signing settings in a single response.
GET /zones/{zone_id}/settings/transformations_config - Read
Get zone setting
Fetch a single zone setting by name
GET /zones/{zone_id}/settings/{setting_id} - Write
Edit multiple zone settings (deprecated)
Edit settings for a zone.
PATCH /zones/{zone_id}/settings - Write
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.
PATCH /zones/{zone_id}/settings/aegis - Write
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.
PATCH /zones/{zone_id}/settings/automatic_platform_optimization - Write
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.
PATCH /zones/{zone_id}/settings/binary_ast - Write
Change Cloudflare 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.
PATCH /zones/{zone_id}/settings/fonts - Write
Change HTTP/2 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.
PATCH /zones/{zone_id}/settings/h2_prioritization - Write
Change Image Transformations setting
Sets the Image Transformations setting for a zone. Accepted values are `off`, `on`, `open`, and `latest`.
PATCH /zones/{zone_id}/settings/image_resizing - Write
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.
PATCH /zones/{zone_id}/settings/origin_h2_max_streams - Write
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](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1".
PATCH /zones/{zone_id}/settings/origin_max_http_version - Write
Change Cloudflare 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.
PATCH /zones/{zone_id}/settings/speed_brain - Write
Change Image 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.
PATCH /zones/{zone_id}/settings/transformations_allowed_origins - Write
Change Image 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.
PATCH /zones/{zone_id}/settings/transformations_c2pa - Write
Change Transformations configuration
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.
PATCH /zones/{zone_id}/settings/transformations_config - Write
Edit zone setting
Updates a single zone setting by the identifier
PATCH /zones/{zone_id}/settings/{setting_id} - Destructive
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.
DELETE /zones/{zone_id}/settings/aegis
Origin TLS
- Read
Get Auto-Origin TLS KEX enrollment status for the given zone
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.
GET /zones/{zone_id}/settings/auto_origin_tls_kex - Read
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.
GET /zones/{zone_id}/settings/origin_tls_compliance_modes - Write
Patch Auto-Origin TLS KEX enrollment status for the given zone
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.
PATCH /zones/{zone_id}/settings/auto_origin_tls_kex - Destructive
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).
DELETE /zones/{zone_id}/settings/origin_tls_compliance_modes - Destructive
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.
PATCH /zones/{zone_id}/settings/origin_tls_compliance_modes - Destructive
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.
PUT /zones/{zone_id}/settings/origin_tls_compliance_modes
CSAM Scanner Settings
- Read
Get CSAM Scanner setting
Retrieve the current CSAM Scanner configuration for a zone. The notification email is masked by default in responses.
GET /zones/{zone_id}/settings/csam_scanner_third_party - Destructive
Update CSAM Scanner setting
Update the CSAM Scanner configuration for a zone. Allows enabling or disabling CSAM scanning, updating the notification email, and configuring scanning sources. This is a partial update: fields omitted from `value` keep their current setting, and `sources` is merged per source (`null` clears all sources). Send an empty `email` to clear the notification address. When a new email is provided, email verification is triggered automatically. The `enabled` field is a toggle; the server may adjust it based on whether the notification email is verified. Returns 403 if the zone or account is locked by Trust & Safety.
PATCH /zones/{zone_id}/settings/csam_scanner_third_party
Google Tag Gateway
- Read
Get Google Tag Gateway configuration
Gets the Google Tag Gateway configuration for a zone.
GET /zones/{zone_id}/settings/google-tag-gateway/config - Destructive
Update Google Tag Gateway configuration
Updates the Google Tag Gateway configuration for a zone.
PUT /zones/{zone_id}/settings/google-tag-gateway/config
NEL Settings
- Read
Get NEL setting
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.
GET /zones/{zone_id}/settings/nel - Write
Edit NEL setting
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.
PATCH /zones/{zone_id}/settings/nel
Automatic SSL/TLS
- Read
Get Automatic SSL/TLS enrollment status for the given zone
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.
GET /zones/{zone_id}/settings/ssl_automatic_mode - Write
Patch Automatic SSL/TLS Enrollment status for given zone
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".
PATCH /zones/{zone_id}/settings/ssl_automatic_mode
Zaraz
- Read
Get Zaraz configuration
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.
GET /zones/{zone_id}/settings/zaraz/config - Read
Get default Zaraz configuration
Gets default Zaraz configuration for a zone.
GET /zones/{zone_id}/settings/zaraz/default - Read
Export Zaraz configuration
Exports full current published Zaraz configuration for a zone, secret variables included.
GET /zones/{zone_id}/settings/zaraz/export - Read
List Zaraz historical configuration records
Lists a history of published Zaraz configuration records for a zone.
GET /zones/{zone_id}/settings/zaraz/history - Read
Get Zaraz historical configurations by ID(s)
Gets a history of published Zaraz configurations by ID(s) for a zone.
GET /zones/{zone_id}/settings/zaraz/history/configs - Read
Get Zaraz workflow
Gets Zaraz workflow for a zone.
GET /zones/{zone_id}/settings/zaraz/workflow - Write
Publish Zaraz preview configuration
Publish current Zaraz preview configuration for a zone.
POST /zones/{zone_id}/settings/zaraz/publish - Destructive
Update Zaraz configuration
Updates Zaraz configuration for a zone.
PUT /zones/{zone_id}/settings/zaraz/config - Destructive
Restore Zaraz historical configuration by ID
Restores a historical published Zaraz configuration by ID for a zone.
PUT /zones/{zone_id}/settings/zaraz/history - Destructive
Update Zaraz workflow
Updates Zaraz workflow for a zone.
PUT /zones/{zone_id}/settings/zaraz/workflow
Smart Shield Settings
- Read
Get Smart Shield Settings
Retrieve Smart Shield Settings.
GET /zones/{zone_id}/smart_shield - Write
Patch Smart Shield Settings
Set Smart Shield Settings.
PATCH /zones/{zone_id}/smart_shield
Cache Reserve Clear
- Read
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.
GET /zones/{zone_id}/smart_shield/cache_reserve_clear - Destructive
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.
POST /zones/{zone_id}/smart_shield/cache_reserve_clear
Zone Snippets
- Read
List zone snippets
Fetches all snippets belonging to the zone.
GET /zones/{zone_id}/snippets - Read
List zone snippet rules
Fetches all snippet rules belonging to the zone.
GET /zones/{zone_id}/snippets/snippet_rules - Read
Get a zone snippet
Fetches a snippet belonging to the zone.
GET /zones/{zone_id}/snippets/{snippet_name} - Read
Get a zone snippet content
Fetches the content of a snippet belonging to the zone.
GET /zones/{zone_id}/snippets/{snippet_name}/content - Destructive
Delete zone snippet rules
Deletes all snippet rules belonging to the zone.
DELETE /zones/{zone_id}/snippets/snippet_rules - Destructive
Update zone snippet rules
Updates all snippet rules belonging to the zone.
PUT /zones/{zone_id}/snippets/snippet_rules - Destructive
Delete a zone snippet
Deletes a snippet belonging to the zone. Returns a 4XX response if the zone or snippet no longer exists.
DELETE /zones/{zone_id}/snippets/{snippet_name} - Destructive
Update a zone snippet
Creates or updates a snippet belonging to the zone.
PUT /zones/{zone_id}/snippets/{snippet_name}
Spectrum Applications
- Read
List Spectrum applications
Retrieves a list of currently existing Spectrum applications inside a zone.
GET /zones/{zone_id}/spectrum/apps - Read
Get Spectrum application configuration
Gets the application configuration of a specific application inside a zone.
GET /zones/{zone_id}/spectrum/apps/{app_id} - Read
List Spectrum application protocols
Retrieves a list of Spectrum application protocols available for a zone.
GET /zones/{zone_id}/spectrum/protocols - Write
Create Spectrum application using a name for the origin
Creates a new Spectrum application from a configuration using a name for the origin.
POST /zones/{zone_id}/spectrum/apps - Destructive
Delete Spectrum application
Deletes a previously existing application.
DELETE /zones/{zone_id}/spectrum/apps/{app_id} - Destructive
Update Spectrum application configuration using a name for the origin
Updates a previously existing application's configuration that uses a name for the origin.
PUT /zones/{zone_id}/spectrum/apps/{app_id}
Observatory
- Read
Get quota and availability
Retrieves quota for all plans, as well as the current zone quota.
GET /zones/{zone_id}/speed_api/availabilities - Read
List tested webpages
Lists all webpages which have been tested.
GET /zones/{zone_id}/speed_api/pages - Read
List page test history
Test history (list of tests) for a specific webpage.
GET /zones/{zone_id}/speed_api/pages/{url}/tests - Read
Get a page test result
Retrieves the result of a specific test.
GET /zones/{zone_id}/speed_api/pages/{url}/tests/{test_id} - Read
List core web vital metrics trend
Lists the core web vital metrics trend over time for a specific page.
GET /zones/{zone_id}/speed_api/pages/{url}/trend - Read
Get a page test schedule
Retrieves the test schedule for a page in a specific region.
GET /zones/{zone_id}/speed_api/schedule/{url} - Write
Start page test
Starts a test for a specific webpage, in a specific region.
POST /zones/{zone_id}/speed_api/pages/{url}/tests - Write
Create scheduled page test
Creates a scheduled test for a page.
POST /zones/{zone_id}/speed_api/schedule/{url} - Destructive
Delete all page tests
Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota.
DELETE /zones/{zone_id}/speed_api/pages/{url}/tests - Destructive
Delete scheduled page test
Deletes a scheduled test for a page.
DELETE /zones/{zone_id}/speed_api/schedule/{url}
Analyze Certificate
- Write
Analyze Certificate
Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.
POST /zones/{zone_id}/ssl/analyze
Certificate Packs
- Read
List Certificate Packs
For a given zone, list all active certificate packs.
GET /zones/{zone_id}/ssl/certificate_packs - Read
Get Certificate Pack Quotas
For a given zone, list certificate pack quotas.
GET /zones/{zone_id}/ssl/certificate_packs/quota - Read
Get Certificate Pack
For a given zone, get a certificate pack.
GET /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id} - Write
Order Advanced Certificate Manager Certificate Pack
For a given zone, order an advanced certificate pack.
POST /zones/{zone_id}/ssl/certificate_packs/order - Write
Restart Validation or Update Advanced Certificate Manager Certificate Pack
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.
PATCH /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id} - Destructive
Delete Advanced Certificate Manager Certificate Pack
For a given zone, delete an advanced certificate pack.
DELETE /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}
SSL/TLS Mode Recommendation
- Read
SSL/TLS Recommendation (deprecated)
Retrieve the SSL/TLS Recommender's recommendation for a zone.
GET /zones/{zone_id}/ssl/recommendation
Universal SSL Settings for a Zone
- Read
Universal SSL Settings Details
Get Universal SSL Settings for a Zone.
GET /zones/{zone_id}/ssl/universal/settings - Destructive
Edit Universal SSL Settings
Patch Universal SSL Settings for a Zone.
PATCH /zones/{zone_id}/ssl/universal/settings
SSL Verification
- Read
SSL Verification Details
Get SSL Verification Info for a Zone.
GET /zones/{zone_id}/ssl/verification - Write
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.
PATCH /zones/{zone_id}/ssl/verification/{certificate_pack_id}
Zone Subscription
- Read
Zone Subscription Details
Lists zone subscription details.
GET /zones/{zone_id}/subscription - Write
Create Zone Subscription
Create a zone subscription, either plan or add-ons.
POST /zones/{zone_id}/subscription - Write
Create Zone Subscription
Create a zone subscription, either plan or add-ons. Retained for audit-log coverage. Use the singular `/zones/{zone_id}/subscription` path instead.
POST /zones/{zone_id}/subscriptions - Destructive
Delete Zone Subscription
Deletes a zone's subscription.
DELETE /zones/{zone_id}/subscription - Destructive
Update Zone Subscription
Updates zone subscriptions, either plan or add-ons.
PUT /zones/{zone_id}/subscription - Destructive
Delete Zone Subscription
Deletes a zone's subscription. Retained for audit-log coverage. Use the singular `/zones/{zone_id}/subscription` path instead.
DELETE /zones/{zone_id}/subscriptions - Destructive
Update Zone Subscription
Updates zone subscriptions, either plan or add-ons. Retained for audit-log coverage. Use the singular `/zones/{zone_id}/subscription` path instead.
PUT /zones/{zone_id}/subscriptions
Token Validation Token Configuration
- Read
List token validation configurations
Lists the JWT validation configurations defined for the zone.
GET /zones/{zone_id}/token_validation/config - Read
Get a token validation configuration
Returns a JWT validation configuration by ID.
GET /zones/{zone_id}/token_validation/config/{config_id} - Write
Create a token validation configuration
Creates a JWT validation configuration for the zone.
POST /zones/{zone_id}/token_validation/config - Write
Edit a token validation configuration
Updates only the supplied fields on a JWT validation configuration.
PATCH /zones/{zone_id}/token_validation/config/{config_id} - Destructive
Delete a token validation configuration
Deletes a JWT validation configuration from the zone.
DELETE /zones/{zone_id}/token_validation/config/{config_id} - Destructive
Edit token validation credentials
Updates the configuration's complete key set while allowing omitted fields on existing keys to retain stored values. Omitted key identities are removed.
PATCH /zones/{zone_id}/token_validation/config/{config_id}/credentials - Destructive
Replace token validation credentials
Replaces the configuration's complete key set. Symmetric keys must include their key material.
PUT /zones/{zone_id}/token_validation/config/{config_id}/credentials
Token Validation Token Rules
- Read
List token validation rules
Lists token validation rules for the zone, with filters for configuration, action, state, ID, and host.
GET /zones/{zone_id}/token_validation/rules - Read
Preview a token validation rule
Returns zone operations annotated as included or excluded to preview the rule's coverage before creation.
POST /zones/{zone_id}/token_validation/rules/preview - Read
Get a token validation rule
Returns a token validation rule by ID.
GET /zones/{zone_id}/token_validation/rules/{rule_id} - Write
Create a token validation rule
Creates a token validation rule for the zone.
POST /zones/{zone_id}/token_validation/rules - Write
Edit token validation rules
Updates and reorders multiple token validation rules in one request, then returns the updated rules.
PATCH /zones/{zone_id}/token_validation/rules/bulk - Write
Create token validation rules
Creates multiple token validation rules for the zone in one request.
POST /zones/{zone_id}/token_validation/rules/bulk - Write
Edit a token validation rule
Updates only the supplied fields on a token validation rule.
PATCH /zones/{zone_id}/token_validation/rules/{rule_id} - Destructive
Delete a token validation rule
Deletes a token validation rule from the zone.
DELETE /zones/{zone_id}/token_validation/rules/{rule_id}
URL Normalization
- Read
Get URL Normalization settings
Fetches the current URL Normalization settings.
GET /zones/{zone_id}/url_normalization - Destructive
Delete URL Normalization settings
Deletes the URL Normalization settings.
DELETE /zones/{zone_id}/url_normalization - Destructive
Update URL Normalization settings
Updates the URL Normalization settings.
PUT /zones/{zone_id}/url_normalization
Web3 Hostname
- Read
List Web3 Hostnames
GET /zones/{zone_id}/web3/hostnames
GET /zones/{zone_id}/web3/hostnames - Read
Web3 Hostname Details
GET /zones/{zone_id}/web3/hostnames/{identifier}
GET /zones/{zone_id}/web3/hostnames/{identifier} - Read
IPFS Universal Path Gateway Content List Details
GET /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
GET /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list - Read
List IPFS Universal Path Gateway Content List Entries
GET /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
GET /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries - Read
IPFS Universal Path Gateway Content List Entry Details
GET /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
GET /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier} - Write
Create Web3 Hostname
POST /zones/{zone_id}/web3/hostnames
POST /zones/{zone_id}/web3/hostnames - Write
Edit Web3 Hostname
PATCH /zones/{zone_id}/web3/hostnames/{identifier}
PATCH /zones/{zone_id}/web3/hostnames/{identifier} - Write
Create IPFS Universal Path Gateway Content List Entry
POST /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
POST /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries - Destructive
Delete Web3 Hostname
DELETE /zones/{zone_id}/web3/hostnames/{identifier}
DELETE /zones/{zone_id}/web3/hostnames/{identifier} - Destructive
Update IPFS Universal Path Gateway Content List
PUT /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
PUT /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list - Destructive
Delete IPFS Universal Path Gateway Content List Entry
DELETE /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
DELETE /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier} - Destructive
Edit IPFS Universal Path Gateway Content List Entry
PUT /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
PUT /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
Worker Routes
- Read
List Worker Routes
Returns Worker routes for a zone.
GET /zones/{zone_id}/workers/routes - Read
Get Worker Route
Returns information about a Worker route, including URL pattern and Worker.
GET /zones/{zone_id}/workers/routes/{route_id} - Write
Create Worker Route
Creates a route that maps a URL pattern to a Worker.
POST /zones/{zone_id}/workers/routes - Destructive
Delete Worker Route
Deletes a Worker route.
DELETE /zones/{zone_id}/workers/routes/{route_id} - Destructive
Replace Worker Route
Replaces the URL pattern or Worker associated with a Worker route.
PUT /zones/{zone_id}/workers/routes/{route_id}
Catalog Sync
- Read
List Catalog Syncs
List Catalog Syncs (Closed Beta).
- Read
List Prebuilt Policies
List prebuilt catalog sync policies (Closed Beta).
- Read
Read Catalog Sync
Read a Catalog Sync (Closed Beta).
- Write
Create Catalog Sync
Create a new Catalog Sync (Closed Beta).
- Write
Patch Catalog Sync
Update a Catalog Sync (Closed Beta).
- Write
Run Catalog Sync
Refresh a Catalog Sync's destination by running the sync policy against latest resource catalog (Closed Beta).
- Destructive
Update Catalog Sync
Update a Catalog Sync (Closed Beta).
- Destructive
Delete Catalog Sync
Delete a Catalog Sync (Closed Beta).
On ramps
- Read
List On-ramps
List On-ramps (Closed Beta).
- Read
Read Magic WAN Address Space
Read the Magic WAN Address Space (Closed Beta).
- Read
Read On-ramp
Read an On-ramp (Closed Beta).
- Read
Export as Terraform
Export an On-ramp to terraform ready file(s) (Closed Beta).
- Write
Create On-ramp
Create a new On-ramp (Closed Beta).
- Write
Patch Magic WAN Address Space
Update the Magic WAN Address Space (Closed Beta).
- Write
Patch On-ramp
Update an On-ramp (Closed Beta).
- Write
Apply On-ramp
Apply an On-ramp (Closed Beta).
- Write
Plan On-ramp
Plan an On-ramp (Closed Beta).
- Destructive
Update Magic WAN Address Space
Update the Magic WAN Address Space (Closed Beta).
- Destructive
Update On-ramp
Update an On-ramp (Closed Beta).
- Destructive
Delete On-ramp
Delete an On-ramp (Closed Beta).
Cloud Integrations
- Read
List Cloud Integrations
List Cloud Integrations (Closed Beta).
- Read
Read Cloud Integration
Read a Cloud Integration (Closed Beta).
- Read
Get Cloud Integration Setup Config
Get initial configuration to complete Cloud Integration setup (Closed Beta).
- Write
Create Cloud Integration
Create a new Cloud Integration (Closed Beta).
- Write
Run Discovery for All Integrations
Run discovery for all Cloud Integrations in an account (Closed Beta).
- Write
Patch Cloud Integration
Update a Cloud Integration (Closed Beta).
- Write
Run Discovery
Run discovery for a Cloud Integration (Closed Beta).
- Destructive
Update Cloud Integration
Update a Cloud Integration (Closed Beta).
- Destructive
Delete Cloud Integration
Delete a Cloud Integration (Closed Beta).
Resources
- Read
List Resources
List resources in the Resource Catalog (Closed Beta).
- Read
Export Resources
Export resources in the Resource Catalog as a JSON file (Closed Beta).
- Read
Preview Rego Query
Preview Rego query result against the latest resource catalog (Closed Beta).
- Read
Read Resource
Read an resource from the Resource Catalog (Closed Beta).
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 29, 2026. Cloudflare API docs.