Skip to content
Cloudflare API
Start here
API Reference

Organizations

User API tokens can list and create Organizations, but reading, updating, or deleting an Organization requires a Global API key and your registered email address. The cloudflare_organization Terraform resource therefore requires a Global API key for its full lifecycle.

See Organizations authentication limitations for credential compatibility by operation. Each endpoint’s Security section lists its supported authentication methods, with Accepted Permissions where applicable.

List organizations the user has access to
organizations.list(OrganizationListParams**kwargs) -> SyncSinglePage[Organization]
GET/organizations
Get organization
organizations.get(strorganization_id) -> Organization
GET/organizations/{organization_id}
Create organization
organizations.create(OrganizationCreateParams**kwargs) -> Organization
POST/organizations
Update organization
organizations.update(strorganization_id, OrganizationUpdateParams**kwargs) -> Organization
PUT/organizations/{organization_id}
Delete organization
organizations.delete(strorganization_id) -> OrganizationDeleteResponse
DELETE/organizations/{organization_id}
ModelsExpand Collapse
class Organization: …

References an Organization in the Cloudflare data model.

id: str
create_time: datetime
formatdate-time
meta: Meta
are_child_accounts_accessible_by_org_members: Optional[bool]
hierarchy_tags: Optional[List[str]]

Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return [rootTag, ...intermediateTags, parentTag, selfTag]. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy.

managed_by: Optional[str]
tenant_flags: Optional[MetaTenantFlags]

Enable features for Organizations.

account_creation: str
account_creation_applies_tenant_defaults: str
account_deletion: str
account_migration: str
account_mobility: str
enterprise_capability: str
member_management: str
sub_org_creation: str
tenant_type: Optional[str]
name: str
parent: Optional[Parent]
id: str
name: str
profile: Optional[Profile]
business_address: str
business_email: str
business_name: str
business_phone: str
external_metadata: str
class OrganizationDeleteResponse: …
id: str

OrganizationsOrganization Accounts

OrganizationsOrganization Profile

Get organization profile
organizations.organization_profile.get(strorganization_id) -> Result
GET/organizations/{organization_id}/profile
Modify organization profile.
organizations.organization_profile.update(strorganization_id, OrganizationProfileUpdateParams**kwargs)
PUT/organizations/{organization_id}/profile
ModelsExpand Collapse
class OrganizationProfile: …
business_address: str
business_email: str
business_name: str
business_phone: str
external_metadata: str

OrganizationsMembers

OrganizationsLogs

OrganizationsLogsAudit

Get organization audit logs (Version 2)
organizations.logs.audit.list(strorganization_id, AuditListParams**kwargs) -> SyncCursorPaginationAfter[AuditListResponse]
GET/organizations/{organization_id}/logs/audit
Get resource change history from an organization audit log entry (Version 2)
organizations.logs.audit.history(strid, AuditHistoryParams**kwargs) -> AuditHistoryResponse
GET/organizations/{organization_id}/logs/audit/{id}/history
ModelsExpand Collapse
class AuditListResponse: …
id: Optional[str]

A unique identifier for the audit log entry.

maxLength32
action: Optional[Action]

Provides information about the action performed.

description: Optional[str]

A short description of the action performed.

result: Optional[str]

The result of the action, indicating success or failure.

time: Optional[datetime]

A timestamp indicating when the action was logged.

formatdate-time
type: Optional[str]

A short string that describes the action that was performed.

actor: Optional[Actor]

Provides details about the actor who performed the action.

id: Optional[str]

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: Optional[Literal["api", "api_key", "api_token", 3 more]]

The context in which the action was initiated.

  • api: The action was performed through the API. The specific credential type was not recorded.
  • api_key: The action was authenticated with a Cloudflare Global API Key.
  • api_token: The action was authenticated with an API token.
  • dash: The action was performed through the Cloudflare dashboard.
  • oauth: The action was authenticated with an OAuth token.
  • origin_ca_key: The action was authenticated with an Origin CA key.
One of the following:
"api"
"api_key"
"api_token"
"dash"
"oauth"
"origin_ca_key"
email: Optional[str]

The email of the actor who performed the action.

formatemail
ip_address: Optional[str]

The IP address of the request that performed the action.

token_id: Optional[str]

The API token ID when the actor context is an api_token or oauth.

token_name: Optional[str]

The API token name when the actor context is an api_token or oauth.

type: Optional[Literal["cloudflare_admin", "system", "user"]]

The type of actor.

One of the following:
"cloudflare_admin"
"system"
"user"
organization: Optional[Organization]

Contains organization related information.

id: Optional[str]

A unique identifier for the organization.

raw: Optional[Raw]

Provides raw information about the request and response.

cf_rayid: Optional[str]

The Cloudflare Ray ID for the request.

method: Optional[str]

The HTTP method of the request.

status_code: Optional[int]

The HTTP response status code returned by the API.

uri: Optional[str]

The URI of the request.

user_agent: Optional[str]

The client’s user agent string sent with the request.

resource: Optional[Resource]

Provides details about the affected resource.

id: Optional[str]

The unique identifier for the affected resource.

product: Optional[str]

The Cloudflare product associated with the resource.

request: Optional[object]
response: Optional[object]
scope: Optional[object]

The scope of the resource.

type: Optional[str]

The type of the resource.

List[AuditHistoryResponseItem]
id: Optional[str]

A unique identifier for the audit log entry.

maxLength32
action: Optional[AuditHistoryResponseItemAction]

Provides information about the action performed.

description: Optional[str]

A short description of the action performed.

result: Optional[str]

The result of the action, indicating success or failure.

time: Optional[datetime]

A timestamp indicating when the action was logged.

formatdate-time
type: Optional[str]

A short string that describes the action that was performed.

actor: Optional[AuditHistoryResponseItemActor]

Provides details about the actor who performed the action.

id: Optional[str]

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: Optional[Literal["api", "api_key", "api_token", 3 more]]

The context in which the action was initiated.

  • api: The action was performed through the API. The specific credential type was not recorded.
  • api_key: The action was authenticated with a Cloudflare Global API Key.
  • api_token: The action was authenticated with an API token.
  • dash: The action was performed through the Cloudflare dashboard.
  • oauth: The action was authenticated with an OAuth token.
  • origin_ca_key: The action was authenticated with an Origin CA key.
One of the following:
"api"
"api_key"
"api_token"
"dash"
"oauth"
"origin_ca_key"
email: Optional[str]

The email of the actor who performed the action.

formatemail
ip_address: Optional[str]

The IP address of the request that performed the action.

token_id: Optional[str]

The API token ID when the actor context is an api_token or oauth.

token_name: Optional[str]

The API token name when the actor context is an api_token or oauth.

type: Optional[Literal["cloudflare_admin", "system", "user"]]

The type of actor.

One of the following:
"cloudflare_admin"
"system"
"user"
organization: Optional[AuditHistoryResponseItemOrganization]

Contains organization related information.

id: Optional[str]

A unique identifier for the organization.

raw: Optional[AuditHistoryResponseItemRaw]

Provides raw information about the request and response.

cf_rayid: Optional[str]

The Cloudflare Ray ID for the request.

method: Optional[str]

The HTTP method of the request.

status_code: Optional[int]

The HTTP response status code returned by the API.

uri: Optional[str]

The URI of the request.

user_agent: Optional[str]

The client’s user agent string sent with the request.

resource: Optional[AuditHistoryResponseItemResource]

Provides details about the affected resource.

id: Optional[str]

The unique identifier for the affected resource.

product: Optional[str]

The Cloudflare product associated with the resource.

request: Optional[object]
response: Optional[object]
scope: Optional[object]

The scope of the resource.

type: Optional[str]

The type of the resource.

OrganizationsBilling

OrganizationsBillingUsage

Get Organization Usage (Version 2, Alpha, Restricted)
organizations.billing.usage.get(strorganization_id, UsageGetParams**kwargs) -> UsageGetResponse
GET/organizations/{organization_id}/billable/usage
ModelsExpand Collapse
List[UsageGetResponseItem]

Contains the array of cost and usage records.

charge_category: Literal["Usage"]

Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported.

charge_description: str

Self-contained summary of the charge’s purpose and price.

charge_frequency: Literal["Usage-Based"]

Indicates how often a charge occurs. Currently only “Usage-Based” is supported.

charge_period_end: datetime

Exclusive end of the time interval during which the usage was consumed.

formatdate-time
charge_period_start: datetime

Inclusive start of the time interval during which the usage was consumed.

formatdate-time
consumed_unit: str

Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”).

host_provider_name: str

Name of the entity providing the underlying infrastructure or platform.

invoice_issuer_name: str

Name of the entity responsible for invoicing for the services consumed.

service_provider_name: str

Name of the entity that made the services available for purchase.

x_billable_metric_id: str

The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId.

billed_cost: Optional[float]

A charge serving as the basis for invoicing, inclusive of all reduced rates and discounts while excluding the amortization of upfront charges (one-time or recurring).

billing_account_id: Optional[str]

Public identifier of the Cloudflare account (account tag). Omitted when account is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by account: that usage is returned as its own record with no account.

billing_account_name: Optional[str]

Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level.

billing_currency: Optional[str]

Currency that a charge was billed in (ISO 4217).

billing_period_end: Optional[datetime]

Exclusive end of the billing cycle that contains this usage record.

formatdate-time
billing_period_start: Optional[datetime]

Inclusive start of the billing cycle that contains this usage record.

formatdate-time
charge_class: Optional[Literal["Correction"]]

Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period.

consumed_quantity: Optional[float]

Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations.

contracted_cost: Optional[float]

Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.

contracted_unit_price: Optional[float]

The agreed-upon unit price for a single PricingUnit of the associated billable metric, inclusive of negotiated discounts, if present, while excluding any other discounts.

effective_cost: Optional[float]

The amortized cost of the charge after applying all reduced rates, discounts, and the applicable portion of relevant, prepaid purchases (one-time or recurring) that covered the charge.

list_cost: Optional[float]

Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.

list_unit_price: Optional[float]

Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts.

pricing_quantity: Optional[float]

Volume of a given service used or purchased, based on the PricingUnit.

pricing_unit: Optional[str]

Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing.

region_id: Optional[str]

Provider-assigned identifier for an isolated geographic area where a service is provided.

region_name: Optional[str]

Name of an isolated geographic area where a service is provided.

sub_account_id: Optional[str]

Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID.

sub_account_name: Optional[str]

Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name.

tags: Optional[Dict[str, Union[str, Literal[true]]]]

Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.

One of the following:
str
Literal[true]
x_billable_metric_name: Optional[str]

The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter.

x_product_category_name: Optional[str]

The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory.

x_product_family_id: Optional[str]

The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId.

x_product_family_name: Optional[str]

The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName.

x_zone_id: Optional[str]

The identifier for the Cloudflare zone (zone tag). Omitted when zone is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by zone. Cloudflare extension.

x_zone_name: Optional[str]

The display name of the Cloudflare zone. Omitted when zone is not part of the requested grouping, and for usage measured at contract level. Cloudflare extension.