Cloudflare API | User › Tokens › Create Token

API Reference

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

User

user

Methods

Edit User -> Envelope<unknown>

patch/user

Edit part of your user details.

User Details -> Envelope<unknown>

get/user

User Details

Audit Logs

user.audit_logs

Methods

Get User Audit Logs -> V4PagePaginationArray<

>

get/user/audit_logs

Gets a list of audit logs for a user account. Can be filtered by who made the change, on which zone, and the timeframe of the change.

Billing

user.billing

History

user.billing.history

Methods

Billing History Details -> V4PagePaginationArray<

>

get/user/billing/history

Accesses your billing history object.

Domain types

BillingHistory = { id, action, amount, 5 more... }

Profile

user.billing.profile

Methods

Billing Profile Details -> Envelope<{ id, account_type, address, 36 more... }>

get/user/billing/profile

Accesses your billing profile object.

Invites

user.invites

Methods

Respond To Invitation -> Envelope<

>

patch/user/invites/{invite_id}

Responds to an invitation.

Invitation Details -> Envelope<

>

get/user/invites/{invite_id}

Gets the details of an invitation.

List Invitations -> SinglePage<

>

get/user/invites

Lists all invitations associated with my user.

Domain types

Invite = { invited_member_id, organization_id, id, 8 more... }

Organizations

user.organizations

Methods

Leave Organization -> { id }

delete/user/organizations/{organization_id}

Removes association to an organization.

Organization Details -> Envelope<unknown>

get/user/organizations/{organization_id}

Gets a specific organization the user is associated with.

List Organizations -> V4PagePaginationArray<

>

get/user/organizations

Lists organizations the user is associated with.

Domain types

Organization = { id, name, permissions, 2 more... }

Subscriptions

user.subscriptions

Methods

Delete User Subscription -> { subscription_id }

delete/user/subscriptions/{identifier}

Deletes a user's subscription.

Get User Subscriptions -> Envelope<Array<

>>

get/user/subscriptions

Lists all of a user's subscriptions.

Update User Subscription -> Envelope<unknown>

put/user/subscriptions/{identifier}

Updates a user's subscriptions.

Tokens

user.tokens

Methods

Create Token -> Envelope<{ id, condition, expires_on, 8 more... }>

post/user/tokens

Create a new access token.

Security

API Token

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Response fields

errors: Array<

>

messages: Array<

>

success: true

Whether the API call was successful

result: { id, condition, expires_on, 8 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/user/tokens \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "name": "readonly token",
      "policies": [
        {
          "id": "f267e341f3dd4697bd3b9f71dd96247f",
          "effect": "allow",
          "permission_groups": [
            {
              "id": "c8fed203ed3043cba015a93ad1616f1f"
            },
            {
              "id": "82e64a83756745bbbb1c9c2701bf816b"
            }
          ],
          "resources": {
            "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*",
            "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*"
          }
        }
      ],
      "expires_on": "2020-01-01T00:00:00Z",
      "not_before": "2018-07-01T05:20:00Z"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "id": "ed17574386854bf78a67040be0a770b0",
    "condition": {
      "request_ip": {
        "in": [
          "123.123.123.0/24",
          "2606:4700::/32"
        ],
        "not_in": [
          "123.123.123.100/24",
          "2606:4700:4700::/48"
        ]
      }
    },
    "expires_on": "2020-01-01T00:00:00Z",
    "issued_on": "2018-07-01T05:20:00Z",
    "last_used_on": "2020-01-02T12:34:00Z",
    "modified_on": "2018-07-02T05:20:00Z",
    "name": "readonly token",
    "not_before": "2018-07-01T05:20:00Z",
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "effect": "allow",
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Magic Network Monitoring"
          }
        ],
        "resources": {
          "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*",
          "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*"
        }
      }
    ],
    "status": "active",
    "value": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
  }
}

Delete Token -> Envelope<{ id }>

delete/user/tokens/{token_id}

Destroy a token.

Token Details -> Envelope<

>

get/user/tokens/{token_id}

Get information about a specific token.

List Tokens -> V4PagePaginationArray<

>

get/user/tokens

List all access tokens you created.

Update Token -> Envelope<

>

put/user/tokens/{token_id}

Update an existing token.

Verify Token -> Envelope<{ id, status, expires_on, 1 more... }>

get/user/tokens/verify

Test whether a token works.

Permission Groups

user.tokens.permission_groups

Methods

List Token Permission Groups -> SinglePage<unknown>

get/user/tokens/permission_groups

Find all available permission groups for API Tokens

Value

user.tokens.value

Methods

Roll Token -> Envelope<

>

put/user/tokens/{token_id}/value

Roll the token secret.