Cloudflare API | Accounts › Account Details

get/accounts/{account_id}

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

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Trust and Safety Write Trust and Safety Read DNS View Write DNS View Read SCIM Provisioning Load Balancers Account Write Load Balancers Account Read Cloudflare Zero Trust PII Read DDoS Botnet Feed Write DDoS Botnet Feed Read Workers R2 Storage Write Workers R2 Storage Read DDoS Protection Write DDoS Protection Read Workers Tail Read Workers KV Storage Write Workers KV Storage Read Workers Scripts Write Workers Scripts Read Load Balancing: Monitors and Pools Write Load Balancing: Monitors and Pools Read Account Firewall Access Rules Write Account Firewall Access Rules Read DNS Firewall Write DNS Firewall Read Billing Write Billing Read Account Settings Write Account Settings Read

Parameters

account_id: string

(maxLength: 32)

Account identifier tag.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result:

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "name": "Demo Account",
    "settings": {
      "abuse_contact_email": "abuse_contact_email",
      "default_nameservers": "cloudflare.standard",
      "enforce_twofactor": true,
      "use_account_custom_ns_by_default": true
    }
  }
}

List Accounts -> V4PagePaginationArray<

get/accounts

List all accounts you have ownership or verified access to.

Update Account -> Envelope<

put/accounts/{account_id}

Update an existing account.

Domain types

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

Logs

accounts.logs

Accounts Logs

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.

Members

accounts.members

Methods

Add Member -> Envelope<

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<

get/accounts/{account_id}/members/{member_id}

Get information about a specific member of an account.

List Members -> V4PagePaginationArray<

get/accounts/{account_id}/members

List all members of an account.

Update Member -> Envelope<

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.

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 -> V4PagePaginationArray<

Role

get/accounts/{account_id}/roles

Get all available roles for an account.

Subscriptions

accounts.subscriptions

Methods

Create Subscription -> Envelope<unknown>

post/accounts/{account_id}/subscriptions

Creates an account subscription.

Delete Subscription -> Envelope<{ subscription_id }>

delete/accounts/{account_id}/subscriptions/{subscription_identifier}

Deletes an account's subscription.

List Subscriptions -> SinglePage<

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.