Skip to content
Cloudflare API
Start here
API Reference

Organizations

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
Modify 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
flags: Optional[MetaFlags]

Enable features for Organizations.

account_creation: str
account_deletion: str
account_migration: str
account_mobility: str
sub_org_creation: str
managed_by: 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, Beta release)
organizations.logs.audit.list(strorganization_id, AuditListParams**kwargs) -> SyncCursorPaginationAfter[AuditListResponse]
GET/organizations/{organization_id}/logs/audit
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_key", "api_token", "dash", 2 more]]
One of the following:
"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.