Skip to content
Cloudflare API
Start here
API Reference

Tenants

Get tenant
tenants.get(strtenant_id) -> Tenant
GET/tenants/{tenant_id}
ModelsExpand Collapse
class Tenant: …
cdate: datetime
formatdate-time
edate: datetime
formatdate-time
tenant_contacts: TenantContacts
email: Optional[str]
website: Optional[str]
tenant_labels: List[str]
tenant_metadata: TenantMetadata
dns: Optional[TenantMetadataDNS]
ns_pool: TenantMetadataDNSNSPool
primary: Optional[str]
secondary: Optional[str]
tenant_name: str
tenant_network: object
tenant_status: str
tenant_tag: str
tenant_type: str
tenant_units: List[TenantUnit]
unit_memberships: List[object]
unit_metadata: object
unit_name: str
unit_status: str
unit_tag: str
customer_id: Optional[str]

TenantsAccount Types

Get tenant account types
tenants.account_types.list(strtenant_id) -> SyncSinglePage[AccountTypeListResponse]
GET/tenants/{tenant_id}/account_types
ModelsExpand Collapse
str

TenantsAccounts

List tenant accounts
tenants.accounts.list(strtenant_id) -> SyncSinglePage[TenantAccount]
GET/tenants/{tenant_id}/accounts
ModelsExpand Collapse
class TenantAccount: …
id: str
created_on: datetime
formatdate-time
name: Optional[str]
settings: Settings
abuse_contact_email: Optional[str]
access_approval_expiry: Optional[datetime]
formatdate-time
api_access_enabled: Optional[bool]
Deprecateddefault_nameservers: Optional[str]

Use DNS Settings instead. Deprecated.

enforce_twofactor: Optional[bool]
Deprecateduse_account_custom_ns_by_default: Optional[bool]

Use DNS Settings instead. Deprecated.

type: Literal["standard", "enterprise"]
One of the following:
"standard"
"enterprise"

TenantsEntitlements

List tenant entitlements
tenants.entitlements.get(strtenant_id) -> TenantEntitlements
GET/tenants/{tenant_id}/entitlements
ModelsExpand Collapse
class TenantEntitlements: …
allow_add_subdomain: AllowAddSubdomain
type: Literal["bool"]
value: bool
allow_auto_accept_invites: AllowAutoAcceptInvites
type: Literal["bool"]
value: bool
cname_setup_allowed: CNAMESetupAllowed
type: Literal["bool"]
value: bool
custom_entitlements: Optional[List[CustomEntitlement]]
allocation: CustomEntitlementAllocation
One of the following:
class CustomEntitlementAllocationOrganizationsAPIMaxCountAllocation: …
type: Literal["max_count"]
value: int
class CustomEntitlementAllocationOrganizationsAPIBoolAllocation: …
type: Literal["bool"]
value: bool
class CustomEntitlementAllocationOrganizationsAPINullAllocation: …
type: Literal[""]
value: Optional[object]
feature: CustomEntitlementFeature
key: str
mhs_certificate_count: MhsCertificateCount
type: Literal["max_count"]
value: int
partial_setup_allowed: PartialSetupAllowed
type: Literal["bool"]
value: bool

TenantsMemberships

List tenant memberships
tenants.memberships.list(strtenant_id) -> SyncSinglePage[TenantMembership]
GET/tenants/{tenant_id}/memberships
ModelsExpand Collapse
class TenantMembership: …
user_email: str
user_name: str
user_tag: str