Cloudflare API

API Reference

Overview

Account & User Management

Abuse Reports

Certificate Management

ACM

Certificate Authorities

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

SSL

Cloudflare One

Email Security

Zero Trust

DNS

Account Custom Nameservers

DNS

DNS Firewall

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Magic Transit

Network Interconnects

Observability

Radar

Routing & Performance

Rules

Security

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Workers & Pages

Workers For Platforms

Shared

User

Methods

client.user.get():

UserGetResponse

get/user

User Details

client.user.edit(, ):

UserEditResponse

patch/user

Edit part of your user details.

User

Audit Logs

User.AuditLogs

Methods

client.user.auditLogs.list(, ):

V4PagePaginationArray

AuditLog

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.

User

Billing

User.Billing

User Billing

History

User.Billing.History

Methods

client.user.billing.history.list(, ):

V4PagePaginationArray

BillingHistory

Deprecated

get/user/billing/history

Accesses your billing history object.

Domain types

BillingHistory{…}

User Billing

Profile

User.Billing.Profile

Methods

client.user.billing.profile.get():

ProfileGetResponse

Deprecated

get/user/billing/profile

Accesses your billing profile object.

User

Invites

User.Invites

Methods

client.user.invites.list():

SinglePage

Invite

get/user/invites

Lists all invitations associated with my user.

client.user.invites.get(, ):

Invite

get/user/invites/{invite_id}

Gets the details of an invitation.

client.user.invites.edit(, , ):

Invite

patch/user/invites/{invite_id}

Responds to an invitation.

Domain types

Invite{…}

User

Organizations

User.Organizations

Methods

client.user.organizations.list(, ):

V4PagePaginationArray

Organization

Deprecated

get/user/organizations

Lists organizations the user is associated with.

client.user.organizations.get(, ):

OrganizationGetResponse

Deprecated

get/user/organizations/{organization_id}

Gets a specific organization the user is associated with.

client.user.organizations.delete(, ):

OrganizationDeleteResponse

Deprecated

delete/user/organizations/{organization_id}

Removes association to an organization.

Domain types

Organization{…}

User

Subscriptions

User.Subscriptions

Methods

client.user.subscriptions.get():

SinglePage

Subscription

get/user/subscriptions

Lists all of a user's subscriptions.

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

SubscriptionUpdateResponse

put/user/subscriptions/{identifier}

Updates a user's subscriptions.

client.user.subscriptions.delete(, ):

SubscriptionDeleteResponse

delete/user/subscriptions/{identifier}

Deletes a user's subscription.

User

Tokens

User.Tokens

Methods

client.user.tokens.list(, ):

V4PagePaginationArray

Token

get/user/tokens

List all access tokens you created.

client.user.tokens.get(, ):

Token

get/user/tokens/{token_id}

Get information about a specific token.

client.user.tokens.create(, ):

TokenCreateResponse

post/user/tokens

Create a new access token.

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

Token

put/user/tokens/{token_id}

Update an existing token.

client.user.tokens.delete(, ):

TokenDeleteResponse

| null

delete/user/tokens/{token_id}

Destroy a token.

client.user.tokens.verify():

TokenVerifyResponse

get/user/tokens/verify

Test whether a token works.

User Tokens

Permission Groups

User.Tokens.PermissionGroups

Methods

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

SinglePage

PermissionGroupListResponse

get/user/tokens/permission_groups

Find all available permission groups for API Tokens

User Tokens

Value

User.Tokens.Value

Methods

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

TokenValue

put/user/tokens/{token_id}/value

Roll the token secret.