Cloudflare API | Accounts

Trust and Safety Write Trust and Safety Read DNS View Write DNS View Read SCIM Provisioning Load Balancers Account Write Load Balancers Account Read 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

params:

AccountGetParams

account_id: string

(maxLength: 32, minLength: 32)

Account identifier tag.

Returns

Account

id: string

(maxLength: 32, minLength: 32)

Identifier

name: string

(maxLength: 100)

Account name

type: "standard" | "enterprise"

created_on?: string

(format: date-time)

Timestamp for the creation of the account

managed_by?:

ManagedBy

Parent container details

settings?:

Settings

Account settings

Request example

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const account = await client.accounts.get({ account_id: '023e105f4ecef8ad9ca31a8372d0c353' });

console.log(account.id);

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "Demo Account",
    "type": "standard",
    "created_on": "2014-03-01T12:21:02.0000Z",
    "managed_by": {
      "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
      "parent_org_name": "Demo Parent Organization"
    },
    "settings": {
      "abuse_contact_email": "abuse_contact_email",
      "enforce_twofactor": true
    }
  }
}

client.accounts.create(, ):

Account

post/accounts

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

client.accounts.update(, ):

Account

put/accounts/{account_id}

Update an existing account.

client.accounts.delete(, ):

AccountDeleteResponse

| null

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

Domain types

Account{…}

Accounts

Logs

Accounts.Logs

Accounts Logs

Audit

Accounts.Logs.Audit

Methods

client.accounts.logs.audit.list(, ):

CursorPaginationAfter

AuditListResponse

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

client.accounts.members.list(, ):

V4PagePaginationArray

Member

get/accounts/{account_id}/members

List all members of an account.

client.accounts.members.get(, , ):

Member

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

Get information about a specific member of an account.

client.accounts.members.create(, ):

Member

post/accounts/{account_id}/members

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

client.accounts.members.update(, , ):

Member

put/accounts/{account_id}/members/{member_id}

Modify an account member.

client.accounts.members.delete(, , ):

MemberDeleteResponse

| null

delete/accounts/{account_id}/members/{member_id}

Remove a member from an account.

Domain types

Status = "member" | "invited"

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

Accounts

Roles

Accounts.Roles

Methods

client.accounts.roles.list(, ):

V4PagePaginationArray

Role

get/accounts/{account_id}/roles

Get all available roles for an account.

client.accounts.roles.get(, , ):

Role

get/accounts/{account_id}/roles/{role_id}

Get information about a specific role for an account.

Accounts

Subscriptions

Accounts.Subscriptions

Methods

client.accounts.subscriptions.get(, ):

SinglePage

Subscription

get/accounts/{account_id}/subscriptions

Lists all of an account's subscriptions.

client.accounts.subscriptions.create(, ):

Subscription

post/accounts/{account_id}/subscriptions

Creates an account subscription.

client.accounts.subscriptions.update(, , ):

Subscription

put/accounts/{account_id}/subscriptions/{subscription_identifier}

Updates an account subscription.

client.accounts.subscriptions.delete(, , ):

SubscriptionDeleteResponse

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

Deletes an account's subscription.

Accounts

Tokens

Accounts.Tokens

Methods

client.accounts.tokens.list(, ):

V4PagePaginationArray

Token

get/accounts/{account_id}/tokens

List all Account Owned API tokens created for this account.

client.accounts.tokens.get(, , ):

Token

get/accounts/{account_id}/tokens/{token_id}

Get information about a specific Account Owned API token.

client.accounts.tokens.create(, ):

TokenCreateResponse

post/accounts/{account_id}/tokens

Create a new Account Owned API token.

client.accounts.tokens.update(, , ):

Token

put/accounts/{account_id}/tokens/{token_id}

Update an existing token.

client.accounts.tokens.delete(, , ):

TokenDeleteResponse

| null

delete/accounts/{account_id}/tokens/{token_id}

Destroy an Account Owned API token.

client.accounts.tokens.verify(, ):

TokenVerifyResponse

get/accounts/{account_id}/tokens/verify

Test whether a token works.

Accounts Tokens

Permission Groups

Accounts.Tokens.PermissionGroups

Methods

client.accounts.tokens.permissionGroups.list(, ):

SinglePage

PermissionGroupListResponse

get/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

client.accounts.tokens.permissionGroups.get(, ):

PermissionGroupGetResponse

get/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

Accounts Tokens

Value

Accounts.Tokens.Value

Methods

client.accounts.tokens.value.update(, , ):

TokenValue

put/accounts/{account_id}/tokens/{token_id}/value

Roll the Account Owned API token secret.