LogoCloudflare API

Accounts

accounts

Methods

Create An Account -> Envelope<
Account
>
post/accounts

Create an account (only available for tenant admins at this time)

Delete A Specific Account -> Envelope<{ id }>
delete/accounts/{account_id}

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

Account Details -> Envelope<
Account
>
get/accounts/{account_id}

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

List Accounts -> V4PagePaginationArray<
Account
>
get/accounts

List all accounts you have ownership or verified access to.

Update Account -> Envelope<
Account
>
put/accounts/{account_id}

Update an existing account.

Domain types

Account = { id, name, created_on, 1 more... }
Accounts

Logs

accounts.logs

AccountsLogs

Audit

accounts.logs.audit

Methods

Get Account Audit Logs Version 2 Beta Release -> CursorLimitPagination<{ id, account, action, 4 more... }>
get/accounts/{account_id}/logs/audit

Gets a list of audit logs for an account.

This is the beta release of Audit Logs Version 2. Since this is a beta version, there may be gaps or missing entries in the available audit logs. Be aware of the following limitations.

  • Audit logs are available only for the past 30 days.
  • Error handling is not yet implemented.

Accounts

Members

accounts.members

Methods

Add Member -> Envelope<
Member
>
post/accounts/{account_id}/members

Add a user to the list of members for this account.

Remove Member -> Envelope<{ id }>
delete/accounts/{account_id}/members/{member_id}

Remove a member from an account.

Member Details -> Envelope<
Member
>
get/accounts/{account_id}/members/{member_id}

Get information about a specific member of an account.

List Members -> V4PagePaginationArray<
Member
>
get/accounts/{account_id}/members

List all members of an account.

Update Member -> Envelope<
Member
>
put/accounts/{account_id}/members/{member_id}

Modify an account member.

Domain types

Status = "member" | "invited"

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

Accounts

Roles

accounts.roles

Methods

Role Details -> Envelope<
Role
>
get/accounts/{account_id}/roles/{role_id}

Get information about a specific role for an account.

List Roles -> SinglePage<
Role
>
get/accounts/{account_id}/roles

Get all available roles for an account.

Accounts

Subscriptions

accounts.subscriptions

Methods

Create Subscription -> Envelope<unknown>
post/accounts/{account_id}/subscriptions

Creates an account subscription.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Billing Write

Parameters
account_id: string
(maxLength: 32)

Identifier

Response fields
errors: Array<
ResponseInfo
>
messages: Array<
ResponseInfo
>
result: unknown
success: true

Whether the API call was successful

Request example
200Example
Delete Subscription -> Envelope<{ subscription_id }>
delete/accounts/{account_id}/subscriptions/{subscription_identifier}

Deletes an account's subscription.

List Subscriptions -> Envelope<Array<
Subscription
>>
get/accounts/{account_id}/subscriptions

Lists all of an account's subscriptions.

Update Subscription -> Envelope<unknown>
put/accounts/{account_id}/subscriptions/{subscription_identifier}

Updates an account subscription.

Accounts

Tokens

accounts.tokens

Methods

Create Token -> Envelope<{ id, condition, expires_on, 8 more... }>
post/accounts/{account_id}/tokens

Create a new Account Owned API token.

Delete Token -> Envelope<{ id }>
delete/accounts/{account_id}/tokens/{token_id}

Destroy an Account Owned API token.

Token Details -> Envelope<
Token
>
get/accounts/{account_id}/tokens/{token_id}

Get information about a specific Account Owned API token.

List Tokens -> V4PagePaginationArray<
Token
>
get/accounts/{account_id}/tokens

List all Account Owned API tokens created for this account.

Update Token -> Envelope<
Token
>
put/accounts/{account_id}/tokens/{token_id}

Update an existing token.

Verify Token -> Envelope<{ id, status, expires_on, 1 more... }>
get/accounts/{account_id}/tokens/verify

Test whether a token works.

AccountsTokens

Permission Groups

accounts.tokens.permission_groups

Methods

List Permission Groups -> SinglePage<unknown>
get/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

AccountsTokens

Value

accounts.tokens.value

Methods

Roll Token -> Envelope<
TokenValue
>
put/accounts/{account_id}/tokens/{token_id}/value

Roll the Account Owned API token secret.