Skip to content
Cloudflare API
Start here
API Reference

Accounts

List Accounts
GET/accounts
Account Details
GET/accounts/{account_id}
Create an account
POST/accounts
Update Account
PUT/accounts/{account_id}
Delete a specific account
DELETE/accounts/{account_id}
ModelsExpand Collapse
Account object { id, name, type, 3 more }
id: string

Identifier

maxLength32
minLength32
name: string

Account name

maxLength100
type: "standard" or "enterprise"
One of the following:
"standard"
"enterprise"
created_on: optional string

Timestamp for the creation of the account

formatdate-time
managed_by: optional object { parent_org_id, parent_org_name }

Parent container details

parent_org_id: optional string

ID of the parent Organization, if one exists

maxLength32
parent_org_name: optional string

Name of the parent Organization, if one exists

settings: optional object { abuse_contact_email, enforce_twofactor }

Account settings

abuse_contact_email: optional string

Sets an abuse contact email to notify for abuse reports.

enforce_twofactor: optional boolean

Indicates whether membership in this account requires that Two-Factor Authentication is enabled

AccountDeleteResponse object { id }
id: string

Identifier

maxLength32
minLength32

AccountsAccount Organizations

Move account
POST/accounts/{account_id}/move
ModelsExpand Collapse
AccountOrganizationCreateResponse object { account_id, destination_organization_id, source_organization_id }
account_id: string
destination_organization_id: string
source_organization_id: string

AccountsAccount Profile

Get account profile
GET/accounts/{account_id}/profile
Modify account profile
PUT/accounts/{account_id}/profile
ModelsExpand Collapse
AccountProfile object { business_address, business_email, business_name, 2 more }
business_address: string
business_email: string
business_name: string
business_phone: string
external_metadata: string

AccountsMembers

List Members
GET/accounts/{account_id}/members
Member Details
GET/accounts/{account_id}/members/{member_id}
Add Member
POST/accounts/{account_id}/members
Update Member
PUT/accounts/{account_id}/members/{member_id}
Remove Member
DELETE/accounts/{account_id}/members/{member_id}
ModelsExpand Collapse
Status = "member" or "invited"

Whether the user is a member of the organization or has an invitation pending.

One of the following:
"member"
"invited"
MemberDeleteResponse object { id }
id: string

Identifier

maxLength32
minLength32

AccountsRoles

List Roles
Deprecated
GET/accounts/{account_id}/roles
Role Details
Deprecated
GET/accounts/{account_id}/roles/{role_id}

AccountsSubscriptions

List Subscriptions
GET/{accounts_or_zones}/{account_or_zone_id}/subscriptions
Get Subscription
GET/accounts/{account_id}/subscriptions/{subscription_identifier}
Create Subscription
POST/{accounts_or_zones}/{account_or_zone_id}/subscriptions
Update Subscription
PUT/accounts/{account_id}/subscriptions/{subscription_identifier}
Delete Subscription
DELETE/accounts/{account_id}/subscriptions/{subscription_identifier}
Cancel Delayed Downgrade
POST/accounts/{account_id}/subscriptions/cancel-downgrade
ModelsExpand Collapse
SubscriptionDeleteResponse object { subscription_id }
subscription_id: optional string

Subscription identifier tag.

maxLength32
SubscriptionCancelDowngradeResponse = unknown or string
One of the following:
unknown
string

AccountsSubscriptionsCancel Reason

Create Cancel Reason
POST/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
Get Cancel Reason
GET/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
ModelsExpand Collapse
CancelReasonCreateResponse object { id, other, reason_code, 2 more }
id: optional string

The cancel reason identifier.

other: optional string

Additional cancellation details.

reason_code: optional array of string

The cancellation reason codes.

submitted: optional string

When the cancel reason was submitted.

formatdate-time
subscription_id: optional string

The subscription identifier.

CancelReasonGetResponse object { id, other, reason_code, 2 more }
id: optional string

The cancel reason identifier.

other: optional string

Additional cancellation details.

reason_code: optional array of string

The cancellation reason codes.

submitted: optional string

When the cancel reason was submitted.

formatdate-time
subscription_id: optional string

The subscription identifier.

AccountsSubscriptionsActions

Append Subscription Action
POST/accounts/{account_id}/subscriptions/{subscription_identifier}/action/append

AccountsSubscriptionsBulk

Create Subscriptions
POST/accounts/{account_id}/bulk/subscriptions
ModelsExpand Collapse
BulkCreateResponse = array of unknown

AccountsTokens

List Tokens
GET/accounts/{account_id}/tokens
Token Details
GET/accounts/{account_id}/tokens/{token_id}
Create Token
POST/accounts/{account_id}/tokens
Update Token
PUT/accounts/{account_id}/tokens/{token_id}
Delete Token
DELETE/accounts/{account_id}/tokens/{token_id}
Verify Token
GET/accounts/{account_id}/tokens/verify
ModelsExpand Collapse
TokenCreateResponse object { id, condition, expires_on, 8 more }
id: optional string

Token identifier tag.

maxLength32
condition: optional object { request_ip }
request_ip: optional object { in, not_in }

Client IP restrictions.

in: optional array of TokenConditionCIDRList

List of IPv4/IPv6 CIDR addresses.

not_in: optional array of TokenConditionCIDRList

List of IPv4/IPv6 CIDR addresses.

expires_on: optional string

The expiration time on or after which the JWT MUST NOT be accepted for processing.

formatdate-time
issued_on: optional string

The time on which the token was created.

formatdate-time
last_used_on: optional string

Last time the token was used.

formatdate-time
modified_on: optional string

Last time the token was modified.

formatdate-time
name: optional string

Token name.

maxLength120
not_before: optional string

The time before which the token MUST NOT be accepted for processing.

formatdate-time
policies: optional array of TokenPolicy { id, effect, permission_groups, resources }

List of access policies assigned to the token.

id: string

Policy identifier.

effect: "allow" or "deny"

Allow or deny operations against the resources.

One of the following:
"allow"
"deny"
permission_groups: array of object { id, meta, name }

A set of permission groups that are specified to the policy.

id: string

Identifier of the permission group.

meta: optional object { key, value }

Attributes associated to the permission group.

key: optional string
value: optional string
name: optional string

Name of the permission group.

resources: map[string] or map[map[string]]

A list of resource names that the policy applies to.

One of the following:
IAMResourcesTypeObjectString = map[string]

Map of simple string resource permissions

IAMResourcesTypeObjectNested = map[map[string]]

Map of nested resource permissions

status: optional "active" or "disabled" or "expired"

Status of the token.

One of the following:
"active"
"disabled"
"expired"
value: optional TokenValue

The token value.

maxLength80
minLength40
TokenDeleteResponse object { id }
id: string

Identifier

maxLength32
minLength32
TokenVerifyResponse object { id, status, expires_on, not_before }
id: string

Token identifier tag.

maxLength32
status: "active" or "disabled" or "expired"

Status of the token.

One of the following:
"active"
"disabled"
"expired"
expires_on: optional string

The expiration time on or after which the JWT MUST NOT be accepted for processing.

formatdate-time
not_before: optional string

The time before which the token MUST NOT be accepted for processing.

formatdate-time

AccountsTokensPermission Groups

List Permission Groups
GET/accounts/{account_id}/tokens/permission_groups
List Permission Groups
GET/accounts/{account_id}/tokens/permission_groups
ModelsExpand Collapse
PermissionGroupListResponse object { id, category, name, scopes }
id: optional string

Public ID.

category: optional "developer_platform" or "ai_and_machine_learning" or "dns_and_zones" or 10 more

Product category that this permission group belongs to.

One of the following:
"developer_platform"
"ai_and_machine_learning"
"dns_and_zones"
"app_security"
"rules_and_configuration"
"cloudflare_one_and_zero_trust"
"analytics_and_logs"
"network_services"
"media"
"email_and_messaging"
"cache_and_performance"
"account_and_billing"
"other"
name: optional string

Permission Group Name

scopes: optional array of "com.cloudflare.api.account" or "com.cloudflare.api.account.zone" or "com.cloudflare.api.user" or "com.cloudflare.edge.r2.bucket"

Resources to which the Permission Group is scoped

One of the following:
"com.cloudflare.api.account"
"com.cloudflare.api.account.zone"
"com.cloudflare.api.user"
"com.cloudflare.edge.r2.bucket"
PermissionGroupGetResponse = array of object { id, category, name, scopes }
id: optional string

Public ID.

category: optional "developer_platform" or "ai_and_machine_learning" or "dns_and_zones" or 10 more

Product category that this permission group belongs to.

One of the following:
"developer_platform"
"ai_and_machine_learning"
"dns_and_zones"
"app_security"
"rules_and_configuration"
"cloudflare_one_and_zero_trust"
"analytics_and_logs"
"network_services"
"media"
"email_and_messaging"
"cache_and_performance"
"account_and_billing"
"other"
name: optional string

Permission Group Name

scopes: optional array of "com.cloudflare.api.account" or "com.cloudflare.api.account.zone" or "com.cloudflare.api.user" or "com.cloudflare.edge.r2.bucket"

Resources to which the Permission Group is scoped

One of the following:
"com.cloudflare.api.account"
"com.cloudflare.api.account.zone"
"com.cloudflare.api.user"
"com.cloudflare.edge.r2.bucket"

AccountsTokensValue

Roll Token
PUT/accounts/{account_id}/tokens/{token_id}/value

AccountsLogs

AccountsLogsAudit

Get account audit logs (Version 2)
GET/accounts/{account_id}/logs/audit
Get resource change history from an account audit log entry (Version 2)
GET/accounts/{account_id}/logs/audit/{id}/history
List account audit log product categories (Version 2)
GET/accounts/{account_id}/logs/audit/product_categories
ModelsExpand Collapse
AuditListResponse object { id, account, action, 4 more }
id: optional string

A unique identifier for the audit log entry.

maxLength32
account: optional object { id, name }

Contains account related information.

id: optional string

A unique identifier for the account.

name: optional string

A string that identifies the account name.

action: optional object { description, result, time, type }

Provides information about the action performed.

description: optional string

A short description of the action performed.

result: optional string

The result of the action, indicating success or failure.

time: optional string

A timestamp indicating when the action was logged.

formatdate-time
type: optional string

A short string that describes the action that was performed.

actor: optional object { id, context, email, 4 more }

Provides details about the actor who performed the action.

id: optional string

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: optional "api" or "api_key" or "api_token" or 3 more

The context in which the action was initiated.

  • api: The action was performed through the API. The specific credential type was not recorded.
  • api_key: The action was authenticated with a Cloudflare Global API Key.
  • api_token: The action was authenticated with an API token.
  • dash: The action was performed through the Cloudflare dashboard.
  • oauth: The action was authenticated with an OAuth token.
  • origin_ca_key: The action was authenticated with an Origin CA key.
One of the following:
"api"
"api_key"
"api_token"
"dash"
"oauth"
"origin_ca_key"
email: optional string

The email of the actor who performed the action.

formatemail
ip_address: optional string

The IP address of the request that performed the action.

token_id: optional string

The API token ID when the actor context is an api_token or oauth.

token_name: optional string

The API token name when the actor context is an api_token or oauth.

type: optional "account" or "cloudflare_admin" or "delegated_service" or 2 more

The type of actor.

One of the following:
"account"
"cloudflare_admin"
"delegated_service"
"system"
"user"
raw: optional object { cf_ray_id, method, status_code, 2 more }

Provides raw information about the request and response.

cf_ray_id: optional string

The Cloudflare Ray ID for the request.

method: optional string

The HTTP method of the request.

status_code: optional number

The HTTP response status code returned by the API.

uri: optional string

The URI of the request.

user_agent: optional string

The client’s user agent string sent with the request.

resource: optional object { id, product, request, 3 more }

Provides details about the affected resource.

id: optional string

The unique identifier for the affected resource.

product: optional string

The Cloudflare product associated with the resource.

request: optional unknown
response: optional unknown
scope: optional unknown

The scope of the resource.

type: optional string

The type of the resource.

zone: optional object { id, name }

Provides details about the zone affected by the action.

id: optional string

A string that identifies the zone id.

name: optional string

A string that identifies the zone name.

AuditHistoryResponse = array of object { id, account, action, 4 more }
id: optional string

A unique identifier for the audit log entry.

maxLength32
account: optional object { id, name }

Contains account related information.

id: optional string

A unique identifier for the account.

name: optional string

A string that identifies the account name.

action: optional object { description, result, time, type }

Provides information about the action performed.

description: optional string

A short description of the action performed.

result: optional string

The result of the action, indicating success or failure.

time: optional string

A timestamp indicating when the action was logged.

formatdate-time
type: optional string

A short string that describes the action that was performed.

actor: optional object { id, context, email, 4 more }

Provides details about the actor who performed the action.

id: optional string

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: optional "api" or "api_key" or "api_token" or 3 more

The context in which the action was initiated.

  • api: The action was performed through the API. The specific credential type was not recorded.
  • api_key: The action was authenticated with a Cloudflare Global API Key.
  • api_token: The action was authenticated with an API token.
  • dash: The action was performed through the Cloudflare dashboard.
  • oauth: The action was authenticated with an OAuth token.
  • origin_ca_key: The action was authenticated with an Origin CA key.
One of the following:
"api"
"api_key"
"api_token"
"dash"
"oauth"
"origin_ca_key"
email: optional string

The email of the actor who performed the action.

formatemail
ip_address: optional string

The IP address of the request that performed the action.

token_id: optional string

The API token ID when the actor context is an api_token or oauth.

token_name: optional string

The API token name when the actor context is an api_token or oauth.

type: optional "account" or "cloudflare_admin" or "delegated_service" or 2 more

The type of actor.

One of the following:
"account"
"cloudflare_admin"
"delegated_service"
"system"
"user"
raw: optional object { cf_ray_id, method, status_code, 2 more }

Provides raw information about the request and response.

cf_ray_id: optional string

The Cloudflare Ray ID for the request.

method: optional string

The HTTP method of the request.

status_code: optional number

The HTTP response status code returned by the API.

uri: optional string

The URI of the request.

user_agent: optional string

The client’s user agent string sent with the request.

resource: optional object { id, product, request, 3 more }

Provides details about the affected resource.

id: optional string

The unique identifier for the affected resource.

product: optional string

The Cloudflare product associated with the resource.

request: optional unknown
response: optional unknown
scope: optional unknown

The scope of the resource.

type: optional string

The type of the resource.

zone: optional object { id, name }

Provides details about the zone affected by the action.

id: optional string

A string that identifies the zone id.

name: optional string

A string that identifies the zone name.

AuditProductCategoriesResponse object { label, products, value }

A predefined product category and the resource products it expands to.

label: optional string

A human-readable label for the product category.

products: optional array of object { label, value }

The resource products that the product category expands to.

label: optional string

A human-readable label for the product.

value: optional string

The resource_product value that the product category expands to.

value: optional string

The product category identifier used with the product_category filter.

AccountsSpeed Settings

AccountsSpeed SettingsTransformations

List Image Resizing configurations for account
GET/accounts/{account_id}/settings/transformations
ModelsExpand Collapse
TransformationsConfig object { id, cf_zone_tag, editable, 2 more }

A configuration item for a specific zone and feature.

id: optional string

Feature identifier.

cf_zone_tag: optional string

Zone tag identifier.

editable: optional boolean

Whether this setting can be modified.

modified_on: optional string

When this setting was last modified.

formatdate-time
value: optional string

Current value of the feature setting.

AccountsPayment Methods

List Payment Methods
GET/accounts/{account_id}/payment-methods
Create Payment Method
POST/accounts/{account_id}/payment-methods
Get Payment Method
GET/accounts/{account_id}/payment-methods/{payment_method_id}
Update Payment Method
PUT/accounts/{account_id}/payment-methods/{payment_method_id}
Delete Payment Method
DELETE/accounts/{account_id}/payment-methods/{payment_method_id}
Set Default Payment Method
POST/accounts/{account_id}/payment-methods/{payment_method_id}/set-as-default
ModelsExpand Collapse
PaymentMethodListResponse object { id, address, address2, 22 more }
id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:
"CREDIT_CARD"
"PAYPAL"
"CASHAPP"
"SEPA_DEBIT"
"LINK"
"ACH_DIRECT_DEBIT"
zipcode: optional string

Billing zip code.

PaymentMethodCreateResponse object { id, address, address2, 22 more }
id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:
"CREDIT_CARD"
"PAYPAL"
"CASHAPP"
"SEPA_DEBIT"
"LINK"
"ACH_DIRECT_DEBIT"
zipcode: optional string

Billing zip code.

PaymentMethodGetResponse object { id, address, address2, 22 more }
id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:
"CREDIT_CARD"
"PAYPAL"
"CASHAPP"
"SEPA_DEBIT"
"LINK"
"ACH_DIRECT_DEBIT"
zipcode: optional string

Billing zip code.

PaymentMethodUpdateResponse object { id, address, address2, 22 more }
id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:
"CREDIT_CARD"
"PAYPAL"
"CASHAPP"
"SEPA_DEBIT"
"LINK"
"ACH_DIRECT_DEBIT"
zipcode: optional string

Billing zip code.

PaymentMethodDeleteResponse = unknown or string
One of the following:
unknown
string
PaymentMethodSetAsDefaultResponse = unknown or string
One of the following:
unknown
string

AccountsPay Invoice

Pay Invoice
POST/accounts/{account_id}/pay-invoice
ModelsExpand Collapse
PayInvoiceCreateResponse object { client_secret }
client_secret: optional string

The Stripe client secret for frontend payment confirmation.

AccountsPay Bad Debt

Pay Bad Debt
POST/accounts/{account_id}/pay-bad-debt
ModelsExpand Collapse
PayBadDebtCreateResponse object { client_secret }
client_secret: optional string

The Stripe client secret for frontend payment confirmation.

AccountsReceipts

Get Receipt PDF
GET/accounts/{account_id}/receipts/{receipt_id}/pdf

AccountsInvoices

Toggle PDF Invoices
PATCH/accounts/{account_id}/invoices
ModelsExpand Collapse
InvoiceEditResponse = unknown or string
One of the following:
unknown
string

AccountsClient Secret

Create Setup Intent
POST/accounts/{account_id}/client-secret
ModelsExpand Collapse
ClientSecretCreateResponse object { client_secret }
client_secret: optional string

The Stripe client secret for frontend payment confirmation.