LogoCloudflare API

Accounts

Accounts

Methods

list(, ):
V4PagePaginationArray
<
Account
>
get/accounts

List all accounts you have ownership or verified access to.

get(, ):
Account
get/accounts/{account_id}

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

create(, ):
Account
post/accounts

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

update(, ):
Account
put/accounts/{account_id}

Update an existing account.

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

AccountsLogs

Audit

Accounts.Logs.Audit

Methods

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

list(, ):
V4PagePaginationArray
<
Member
>
get/accounts/{account_id}/members

List all members of an account.

get(, , ):
Member
get/accounts/{account_id}/members/{member_id}

Get information about a specific member of an account.

create(, ):
Member
post/accounts/{account_id}/members

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

update(, , ):
Member
put/accounts/{account_id}/members/{member_id}

Modify an account member.

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

list(, ):
V4PagePaginationArray
<
Role
>
get/accounts/{account_id}/roles

Get all available roles for an account.

get(, , ):
Role
get/accounts/{account_id}/roles/{role_id}

Get information about a specific role for an account.

Accounts

Subscriptions

Accounts.Subscriptions

Methods

get(, ):
SinglePage
<
Subscription
>
get/accounts/{account_id}/subscriptions

Lists all of an account's subscriptions.

create(, ):
Subscription
post/accounts/{account_id}/subscriptions

Creates an account subscription.

update(, , ):
Subscription
put/accounts/{account_id}/subscriptions/{subscription_identifier}

Updates an account subscription.

delete(, , ):
SubscriptionDeleteResponse
delete/accounts/{account_id}/subscriptions/{subscription_identifier}

Deletes an account's subscription.

Accounts

Tokens

Accounts.Tokens

Methods

list(, ):
V4PagePaginationArray
<
Token
>
get/accounts/{account_id}/tokens

List all Account Owned API tokens created for this account.

get(, , ):
Token
get/accounts/{account_id}/tokens/{token_id}

Get information about a specific Account Owned API token.

create(, ):
TokenCreateResponse
post/accounts/{account_id}/tokens

Create a new Account Owned API token.

update(, , ):
Token
put/accounts/{account_id}/tokens/{token_id}

Update an existing token.

delete(, , ):
TokenDeleteResponse
| null
delete/accounts/{account_id}/tokens/{token_id}

Destroy an Account Owned API token.

verify(, ):
TokenVerifyResponse
get/accounts/{account_id}/tokens/verify

Test whether a token works.

AccountsTokens

Permission Groups

Accounts.Tokens.PermissionGroups

Methods

list(, ):
SinglePage
<
PermissionGroupListResponse
>
get/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

get(, ):
PermissionGroupGetResponse
get/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

AccountsTokens

Value

Accounts.Tokens.Value

Methods

update(, , ):
TokenValue
put/accounts/{account_id}/tokens/{token_id}/value

Roll the Account Owned API token secret.