Skip to content
Cloudflare API
Start here
API Reference
Tenants
Entitlements

List tenant entitlements

tenants.entitlements.get(strtenant_id) -> TenantEntitlements
GET/tenants/{tenant_id}/entitlements

List of innate entitlements available for the Tenant.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
tenant_id: str
ReturnsExpand 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

List tenant entitlements

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
tenant_entitlements = client.tenants.entitlements.get(
    "tenant_id",
)
print(tenant_entitlements.allow_add_subdomain)
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "allow_add_subdomain": {
      "type": "bool",
      "value": true
    },
    "allow_auto_accept_invites": {
      "type": "bool",
      "value": true
    },
    "cname_setup_allowed": {
      "type": "bool",
      "value": true
    },
    "custom_entitlements": [
      {
        "allocation": {
          "type": "max_count",
          "value": 0
        },
        "feature": {
          "key": "key"
        }
      }
    ],
    "mhs_certificate_count": {
      "type": "max_count",
      "value": 0
    },
    "partial_setup_allowed": {
      "type": "bool",
      "value": true
    }
  },
  "success": true
}
Returns Examples
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "allow_add_subdomain": {
      "type": "bool",
      "value": true
    },
    "allow_auto_accept_invites": {
      "type": "bool",
      "value": true
    },
    "cname_setup_allowed": {
      "type": "bool",
      "value": true
    },
    "custom_entitlements": [
      {
        "allocation": {
          "type": "max_count",
          "value": 0
        },
        "feature": {
          "key": "key"
        }
      }
    ],
    "mhs_certificate_count": {
      "type": "max_count",
      "value": 0
    },
    "partial_setup_allowed": {
      "type": "bool",
      "value": true
    }
  },
  "success": true
}