Create an Account

POST/accounts

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. Account names are limited to 65 UTF-8 bytes.

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

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

Header ParametersExpand Collapse

"Idempotency-Key": optional string

maxLength128

minLength1

Body ParametersJSONExpand Collapse

name: string

Account name, limited to 65 UTF-8 bytes.

standalone: optional true

Set to true and omit unit to create a standalone Free Account. If provided, this field must be true.

Deprecatedtype: optional "standard" or "enterprise"

The ‘type’ field should no longer be set through the API.

the type of account being created. For self-serve customers, use standard. for enterprise customers, use enterprise.

One of the following:

"standard"

"enterprise"

unit: optional object { id }

Information related to the tenant unit. Provide its ID and omit standalone to create the Account within an Organization. See https://developers.cloudflare.com/tenant/how-to/manage-accounts/.

id: optional string

Tenant unit ID

ReturnsExpand Collapse

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result: optional Account { id, name, type, 4 more }

id: string

Identifier

maxLength32

minLength32

name: string

Account name

type: "standard" or "enterprise"

One of the following:

"standard"

"enterprise"

created_on: optional string

Timestamp for the creation of the account

formatdate-time

legacy_flags: optional object { enterprise_zone_quota }

Legacy account flags.

enterprise_zone_quota: optional object { available, current, maximum }

Enterprise zone quota for standard and enterprise accounts. Accounts without a quota have a maximum of 0.

available: optional number

Number of additional Enterprise zones available. Returns 0 if the quota is not allocated or is exhausted.

current: optional number

Current number of Enterprise zones.

maximum: optional number

Maximum number of Enterprise zones allowed.

managed_by: optional object { parent_org_id, parent_org_name, root_org_id, should_display_parent_orgs }

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

root_org_id: optional string

ID of the root Organization, if one exists

maxLength32

should_display_parent_orgs: optional boolean

Indicates whether the parent Organization hierarchy should be displayed

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

Create an Account

curl https://api.cloudflare.com/client/v4/accounts \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "name": "name",
          "type": "standard"
        }'

{
  "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:02Z",
    "legacy_flags": {
      "enterprise_zone_quota": {
        "available": 168,
        "current": 82,
        "maximum": 250
      }
    },
    "managed_by": {
      "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
      "parent_org_name": "Demo Parent Organization",
      "root_org_id": "46f0a1ce86ec3d91fae00db3b8b48cee",
      "should_display_parent_orgs": true
    },
    "settings": {
      "abuse_contact_email": "abuse_contact_email",
      "enforce_twofactor": true
    }
  }
}

Returns Examples

{
  "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:02Z",
    "legacy_flags": {
      "enterprise_zone_quota": {
        "available": 168,
        "current": 82,
        "maximum": 250
      }
    },
    "managed_by": {
      "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
      "parent_org_name": "Demo Parent Organization",
      "root_org_id": "46f0a1ce86ec3d91fae00db3b8b48cee",
      "should_display_parent_orgs": true
    },
    "settings": {
      "abuse_contact_email": "abuse_contact_email",
      "enforce_twofactor": true
    }
  }
}