Skip to content
Cloudflare API
Start here
API Reference

Tenants

Get tenant
client.tenants.get(stringtenantId, RequestOptionsoptions?): Tenant { cdate, edate, tenant_contacts, 9 more }
GET/tenants/{tenant_id}
ModelsExpand Collapse
Tenant { cdate, edate, tenant_contacts, 9 more }
cdate: string
formatdate-time
edate: string
formatdate-time
tenant_contacts: TenantContacts { email, website }
email?: string
website?: string
tenant_labels: Array<string>
tenant_metadata: TenantMetadata { dns }
dns?: DNS { ns_pool }
ns_pool: NSPool { primary, secondary }
primary?: string
secondary?: string
tenant_name: string
tenant_network: unknown
tenant_status: string
tenant_tag: string
tenant_type: string
tenant_units: Array<TenantUnit>
unit_memberships: Array<unknown>
unit_metadata: unknown
unit_name: string
unit_status: string
unit_tag: string
customer_id?: string

TenantsAccount Types

Get tenant account types
client.tenants.accountTypes.list(stringtenantId, RequestOptionsoptions?): SinglePage<AccountTypeListResponse>
GET/tenants/{tenant_id}/account_types
ModelsExpand Collapse
AccountTypeListResponse = string

TenantsAccounts

List tenant accounts
client.tenants.accounts.list(stringtenantId, RequestOptionsoptions?): SinglePage<TenantAccount { id, created_on, name, 2 more } >
GET/tenants/{tenant_id}/accounts
ModelsExpand Collapse
TenantAccount { id, created_on, name, 2 more }
id: string
created_on: string
formatdate-time
name: string | null
settings: Settings { abuse_contact_email, access_approval_expiry, api_access_enabled, 3 more }
abuse_contact_email: string | null
access_approval_expiry: string | null
formatdate-time
api_access_enabled: boolean | null
Deprecateddefault_nameservers: string | null

Use DNS Settings instead. Deprecated.

enforce_twofactor: boolean | null
Deprecateduse_account_custom_ns_by_default: boolean | null

Use DNS Settings instead. Deprecated.

type: "standard" | "enterprise"
One of the following:
"standard"
"enterprise"

TenantsEntitlements

List tenant entitlements
client.tenants.entitlements.get(stringtenantId, RequestOptionsoptions?): TenantEntitlements { allow_add_subdomain, allow_auto_accept_invites, cname_setup_allowed, 3 more }
GET/tenants/{tenant_id}/entitlements
ModelsExpand Collapse
TenantEntitlements { allow_add_subdomain, allow_auto_accept_invites, cname_setup_allowed, 3 more }
allow_add_subdomain: AllowAddSubdomain { type, value }
type: "bool"
value: boolean
allow_auto_accept_invites: AllowAutoAcceptInvites { type, value }
type: "bool"
value: boolean
cname_setup_allowed: CNAMESetupAllowed { type, value }
type: "bool"
value: boolean
custom_entitlements: Array<CustomEntitlement> | null
allocation: OrganizationsAPIMaxCountAllocation { type, value } | OrganizationsAPIBoolAllocation { type, value } | OrganizationsAPINullAllocation { type, value }
One of the following:
OrganizationsAPIMaxCountAllocation { type, value }
type: "max_count"
value: number
OrganizationsAPIBoolAllocation { type, value }
type: "bool"
value: boolean
OrganizationsAPINullAllocation { type, value }
type: ""
value?: unknown
feature: Feature { key }
key: string
mhs_certificate_count: MhsCertificateCount { type, value }
type: "max_count"
value: number
partial_setup_allowed: PartialSetupAllowed { type, value }
type: "bool"
value: boolean

TenantsMemberships

List tenant memberships
client.tenants.memberships.list(stringtenantId, RequestOptionsoptions?): SinglePage<TenantMembership { user_email, user_name, user_tag } >
GET/tenants/{tenant_id}/memberships
ModelsExpand Collapse
TenantMembership { user_email, user_name, user_tag }
user_email: string
user_name: string
user_tag: string