--- title: Shared --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Shared ##### ModelsExpand Collapse int [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20asn%20%3E%20(schema)>)
class AuditLog: … id: Optional\[str] A string that uniquely identifies the audit log. Link to this property
action: Optional\[Action] result: Optional\[bool] A boolean that indicates if the action attempted was successful. Link to this property type: Optional\[str] A short string that describes the action that was performed. Link to this property
Link to this property
actor: Optional\[Actor] id: Optional\[str] The ID of the actor that performed the action. If a user performed the action, this will be their User ID. Link to this property email: Optional\[str] The email of the user that performed the action. formatemail Link to this property ip: Optional\[str] The IP address of the request that performed the action. Link to this property
type: Optional\[Literal\["user", "admin", "Cloudflare"]] The type of actor, whether a User, Cloudflare Admin, or an Automated System. One of the following: "user" Link to this property "admin" Link to this property "Cloudflare" Link to this property
Link to this property
Link to this property interface: Optional\[str] The source of the event. Link to this property metadata: Optional\[object] An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. Link to this property new\_value: Optional\[str] The new value of the resource that was modified. Link to this property old\_value: Optional\[str] The value of the resource before it was modified. Link to this property
owner: Optional\[Owner] id: Optional\[str] Identifier maxLength32 Link to this property
Link to this property
resource: Optional\[Resource] id: Optional\[str] An identifier for the resource that was affected by the action. Link to this property type: Optional\[str] A short string that describes the resource that was affected by the action. Link to this property
Link to this property when: Optional\[datetime] A UTC RFC3339 timestamp that specifies when the action being logged occured. formatdate-time Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20audit_log%20%3E%20(schema)>)
Literal\["digicert", "google", "lets\_encrypt", "ssl\_com"] The Certificate Authority that will issue the certificate. One of the following: "digicert" Link to this property "google" Link to this property "lets\_encrypt" Link to this property "ssl\_com" Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20certificate_ca%20%3E%20(schema)>)
Literal\["origin-rsa", "origin-ecc", "keyless-certificate"] Signature type desired on certificate (“origin-rsa” (rsa), “origin-ecc” (ecdsa), or “keyless-certificate” (for Keyless SSL servers). One of the following: "origin-rsa" Link to this property "origin-ecc" Link to this property "keyless-certificate" Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20certificate_request_type%20%3E%20(schema)>)
class CloudflareTunnel: … A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
config\_src: Optional\[Literal\["local", "cloudflare"]] Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel on the Zero Trust dashboard. One of the following: "local" Link to this property "cloudflare" Link to this property
Link to this property
Deprecatedconnections: Optional\[List\[Connection]] This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at: Optional\[datetime] Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property Deprecatedremote\_config: Optional\[bool] Use the config\_src field instead. If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine. Link to this property
status: Optional\[Literal\["inactive", "degraded", "healthy", "down"]] The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type: Optional\[Literal\["cfd\_tunnel", "warp\_connector", "warp", 4 more]] The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20cloudflare_tunnel%20%3E%20(schema)>)
class ErrorData: … code: Optional\[int] Link to this property documentation\_url: Optional\[str] Link to this property message: Optional\[str] Link to this property
source: Optional\[Source] pointer: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20error_data%20%3E%20(schema)>)
class Identifier: … id: Optional\[str] The unique identifier for a certificate\_pack. Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20identifier%20%3E%20(schema)>)
class LoadBalancerPreview: … pools: Optional\[Dict\[str, str]] Monitored pool IDs mapped to their respective names. Link to this property preview\_id: Optional\[str] Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20load_balancer_preview%20%3E%20(schema)>)
class Member: … id: Optional\[str] Membership identifier tag. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
policies: Optional\[List\[Policy]] Access policy for the membership id: Optional\[str] Policy identifier. Link to this property
access: Optional\[Literal\["allow", "deny"]] Allow or deny operations against the resources. One of the following: "allow" Link to this property "deny" Link to this property
Link to this property
permission\_groups: Optional\[List\[PolicyPermissionGroup]] A set of permission groups that are specified to the policy. id: str Identifier of the permission group. Link to this property
meta: Optional\[PolicyPermissionGroupMeta] Attributes associated to the permission group. category: Optional\[str] A category used to group permission groups. Link to this property deprecated: Optional\[str] Indicates whether the permission group is deprecated. Link to this property description: Optional\[str] Additional information about the permission group. Link to this property editable: Optional\[str] Indicates whether the permission group can be edited. Link to this property eol\_at: Optional\[datetime] The planned end-of-life date and time, when provided. formatdate-time Link to this property label: Optional\[str] A label identifying the permission group. Link to this property scopes: Optional\[str] The scope associated with the permission group. Link to this property visibility: Optional\[str] Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: Optional\[str] Name of the permission group. Link to this property
Link to this property
resource\_groups: Optional\[List\[PolicyResourceGroup]] A list of resource groups that the policy applies to. id: str Identifier of the resource group. Link to this property
scope: PolicyResourceGroupScope A scope is a combination of scope objects which provides additional context. key: str This is a combination of pre-defined resource name and identifier (like Account ID etc.) Link to this property
objects: List\[PolicyResourceGroupScopeObject] A list of scope objects for additional context. key: str This is a combination of pre-defined resource name and identifier (like Zone ID etc.) Link to this property
Link to this property
Link to this property
meta: Optional\[PolicyResourceGroupMeta] Attributes associated to the resource group. key: Optional\[str] Link to this property value: Optional\[str] Link to this property
Link to this property name: Optional\[str] Name of the resource group. Link to this property
Link to this property
Link to this property
roles: Optional\[List\[Role]] Roles assigned to this Member. id: str Role identifier tag. maxLength32 Link to this property description: str Description of role’s permissions. Link to this property name: str Role name. maxLength120 Link to this property
permissions: Permissions analytics: Optional\[PermissionGrant] Link to this property billing: Optional\[PermissionGrant] Link to this property cache\_purge: Optional\[PermissionGrant] Link to this property dns: Optional\[PermissionGrant] Link to this property dns\_records: Optional\[PermissionGrant] Link to this property lb: Optional\[PermissionGrant] Link to this property logs: Optional\[PermissionGrant] Link to this property organization: Optional\[PermissionGrant] Link to this property ssl: Optional\[PermissionGrant] Link to this property waf: Optional\[PermissionGrant] Link to this property zone\_settings: Optional\[PermissionGrant] Link to this property zones: Optional\[PermissionGrant] Link to this property
Link to this property
Link to this property
status: Optional\[Literal\["accepted", "pending"]] A member’s status in the account. One of the following: "accepted" Link to this property "pending" Link to this property
Link to this property
user: Optional\[User] Details of the user associated to the membership. email: str The contact email address of the user. maxLength90 Link to this property id: Optional\[str] Identifier maxLength32 minLength32 Link to this property first\_name: Optional\[str] User’s first name maxLength60 Link to this property last\_name: Optional\[str] User’s last name maxLength60 Link to this property two\_factor\_authentication\_enabled: Optional\[bool] Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20member%20%3E%20(schema)>)
class PaginationInfo: … count: Optional\[float] Total number of results for the requested service Link to this property page: Optional\[float] Current page within paginated list of results Link to this property per\_page: Optional\[float] Number of results per page of results Link to this property total\_count: Optional\[float] Total results available without any search parameters Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20pagination_info%20%3E%20(schema)>) str [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20permission%20%3E%20(schema)>)
class PermissionGrant: … read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20permission_grant%20%3E%20(schema)>)
class RatePlan: … The rate plan applied to the subscription.
id: Optional\[Literal\["free", "lite", "pro", 7 more]] The ID of the rate plan. One of the following: "free" Link to this property "lite" Link to this property "pro" Link to this property "pro\_plus" Link to this property "business" Link to this property "enterprise" Link to this property "partners\_free" Link to this property "partners\_pro" Link to this property "partners\_business" Link to this property "partners\_enterprise" Link to this property
Link to this property currency: Optional\[str] The currency applied to the rate plan subscription. Link to this property externally\_managed: Optional\[bool] Whether this rate plan is managed externally from Cloudflare. Link to this property is\_contract: Optional\[bool] Whether a rate plan is enterprise-based (or newly adopted term contract). Link to this property public\_name: Optional\[str] The full name of the rate plan. Link to this property scope: Optional\[str] The scope that this rate plan applies to. Link to this property sets: Optional\[List\[str]] The list of sets this rate plan applies to. Returns array of strings. Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20rate_plan%20%3E%20(schema)>)
class ResponseInfo: … code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[Source] pointer: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20response_info%20%3E%20(schema)>)
Result One of the following:
class UnionMember0: …
errors: Optional\[List\[ResponseInfo]] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[Source] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: Optional\[List\[ResponseInfo]] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[Source] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
result: Optional\[List\[AuditLog]] id: Optional\[str] A string that uniquely identifies the audit log. Link to this property
action: Optional\[Action] result: Optional\[bool] A boolean that indicates if the action attempted was successful. Link to this property type: Optional\[str] A short string that describes the action that was performed. Link to this property
Link to this property
actor: Optional\[Actor] id: Optional\[str] The ID of the actor that performed the action. If a user performed the action, this will be their User ID. Link to this property email: Optional\[str] The email of the user that performed the action. formatemail Link to this property ip: Optional\[str] The IP address of the request that performed the action. Link to this property
type: Optional\[Literal\["user", "admin", "Cloudflare"]] The type of actor, whether a User, Cloudflare Admin, or an Automated System. One of the following: "user" Link to this property "admin" Link to this property "Cloudflare" Link to this property
Link to this property
Link to this property interface: Optional\[str] The source of the event. Link to this property metadata: Optional\[object] An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. Link to this property new\_value: Optional\[str] The new value of the resource that was modified. Link to this property old\_value: Optional\[str] The value of the resource before it was modified. Link to this property
owner: Optional\[Owner] id: Optional\[str] Identifier maxLength32 Link to this property
Link to this property
resource: Optional\[Resource] id: Optional\[str] An identifier for the resource that was affected by the action. Link to this property type: Optional\[str] A short string that describes the resource that was affected by the action. Link to this property
Link to this property when: Optional\[datetime] A UTC RFC3339 timestamp that specifies when the action being logged occured. formatdate-time Link to this property
Link to this property success: Optional\[bool] Link to this property
Link to this property
class AaaAPIResponseCommon: …
errors: List\[ResponseInfo] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[Source] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[ResponseInfo] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[Source] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20result%20%3E%20(schema)>)
class Role: … id: str Role identifier tag. maxLength32 Link to this property description: str Description of role’s permissions. Link to this property name: str Role name. maxLength120 Link to this property
permissions: Permissions analytics: Optional\[PermissionGrant] Link to this property billing: Optional\[PermissionGrant] Link to this property cache\_purge: Optional\[PermissionGrant] Link to this property dns: Optional\[PermissionGrant] Link to this property dns\_records: Optional\[PermissionGrant] Link to this property lb: Optional\[PermissionGrant] Link to this property logs: Optional\[PermissionGrant] Link to this property organization: Optional\[PermissionGrant] Link to this property ssl: Optional\[PermissionGrant] Link to this property waf: Optional\[PermissionGrant] Link to this property zone\_settings: Optional\[PermissionGrant] Link to this property zones: Optional\[PermissionGrant] Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20role%20%3E%20(schema)>)
Literal\["asc", "desc"] Direction to order DNS records in. One of the following: "asc" Link to this property "desc" Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20sort_direction%20%3E%20(schema)>)
class Subscription: … id: Optional\[str] Subscription identifier tag. maxLength32 Link to this property currency: Optional\[str] The monetary unit in which pricing information is displayed. Link to this property current\_period\_end: Optional\[datetime] The end of the current period and also when the next billing is due. formatdate-time Link to this property current\_period\_start: Optional\[datetime] When the current billing period started. May match initial\_period\_start if this is the first period. formatdate-time Link to this property
frequency: Optional\[Literal\["weekly", "monthly", "quarterly", "yearly"]] How often the subscription is renewed automatically. One of the following: "weekly" Link to this property "monthly" Link to this property "quarterly" Link to this property "yearly" Link to this property
Link to this property price: Optional\[float] The price of the subscription that will be billed, in US dollars. Link to this property rate\_plan: Optional\[RatePlan] The rate plan applied to the subscription. Link to this property
state: Optional\[Literal\["Trial", "Provisioned", "Paid", 4 more]] The state that the subscription is in. One of the following: "Trial" Link to this property "Provisioned" Link to this property "Paid" Link to this property "AwaitingPayment" Link to this property "Cancelled" Link to this property "Failed" Link to this property "Expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20subscription%20%3E%20(schema)>)
class SubscriptionComponent: … A component value for a subscription. default: Optional\[float] The default amount assigned. Link to this property display\_name: Optional\[str] A human-readable version of the component name. Link to this property
kind: Optional\[Literal\["enum", "sum", "usage"]] The type of component value. “enum” for discrete values (including boolean on/off toggles where 0=off and 1=on), “sum” for countable quantities, “usage” for metered billing components. One of the following: "enum" Link to this property "sum" Link to this property "usage" Link to this property
Link to this property name: Optional\[str] The name of the component value. Link to this property price: Optional\[float] The unit price for the component value. Link to this property value: Optional\[float] The amount of the component value assigned. Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20subscription_component%20%3E%20(schema)>)
class SubscriptionZone: … A simple zone object. May have null properties if not a zone subscription. id: Optional\[str] Identifier maxLength32 Link to this property name: Optional\[str] The domain name maxLength253 Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20subscription_zone%20%3E%20(schema)>)
class Token: … id: Optional\[str] Token identifier tag. maxLength32 Link to this property
condition: Optional\[Condition]
request\_ip: Optional\[ConditionRequestIP] Client IP restrictions. in\_: Optional\[List\[TokenConditionCIDRList]] List of IPv4/IPv6 CIDR addresses. Link to this property not\_in: Optional\[List\[TokenConditionCIDRList]] List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property creator\_email\_at\_creation: Optional\[str] The email address of the user who created the token at the time of creation. Only present for Account Owned API Tokens when a creator email was available. maxLength90 Link to this property expires\_on: Optional\[datetime] The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property issued\_on: Optional\[datetime] The time on which the token was created. formatdate-time Link to this property last\_used\_on: Optional\[datetime] Last time the token was used. formatdate-time Link to this property modified\_on: Optional\[datetime] Last time the token was modified. formatdate-time Link to this property name: Optional\[str] Token name. maxLength120 Link to this property not\_before: Optional\[datetime] The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
policies: Optional\[List\[TokenPolicy]] List of access policies assigned to the token. id: str Policy identifier. Link to this property
effect: Literal\["allow", "deny"] Allow or deny operations against the resources. One of the following: "allow" Link to this property "deny" Link to this property
Link to this property
permission\_groups: List\[PermissionGroup] A set of permission groups that are specified to the policy. id: str Identifier of the permission group. Link to this property
meta: Optional\[PermissionGroupMeta] Attributes associated to the permission group. category: Optional\[str] A category used to group permission groups. Link to this property deprecated: Optional\[str] Indicates whether the permission group is deprecated. Link to this property description: Optional\[str] Additional information about the permission group. Link to this property editable: Optional\[str] Indicates whether the permission group can be edited. Link to this property eol\_at: Optional\[datetime] The planned end-of-life date and time, when provided. formatdate-time Link to this property label: Optional\[str] A label identifying the permission group. Link to this property scopes: Optional\[str] The scope associated with the permission group. Link to this property visibility: Optional\[str] Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: Optional\[str] Name of the permission group. Link to this property
Link to this property
resources: Union\[Dict\[str, str], Dict\[str, Dict\[str, str]]] A list of resource names that the policy applies to. One of the following: Dict\[str, str] Map of simple string resource permissions Link to this property Dict\[str, Dict\[str, str]] Map of nested resource permissions Link to this property
Link to this property
Link to this property provisioner\_id: Optional\[str] The identifier of the service that provisioned the token. For an OAuth-provisioned token, this is the OAuth client identifier. Present when provisioner_type is present and null when the identifier is unavailable. Link to this property provisioner\_type: Optional\[str] The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
status: Optional\[Literal\["active", "disabled", "expired"]] Status of the token. One of the following: "active" Link to this property "disabled" Link to this property "expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token%20%3E%20(schema)>) str IPv4/IPv6 CIDR. [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_condition_cidr_list%20%3E%20(schema)>)
class TokenPolicy: … id: str Policy identifier. Link to this property
effect: Literal\["allow", "deny"] Allow or deny operations against the resources. One of the following: "allow" Link to this property "deny" Link to this property
Link to this property
permission\_groups: List\[PermissionGroup] A set of permission groups that are specified to the policy. id: str Identifier of the permission group. Link to this property
meta: Optional\[PermissionGroupMeta] Attributes associated to the permission group. category: Optional\[str] A category used to group permission groups. Link to this property deprecated: Optional\[str] Indicates whether the permission group is deprecated. Link to this property description: Optional\[str] Additional information about the permission group. Link to this property editable: Optional\[str] Indicates whether the permission group can be edited. Link to this property eol\_at: Optional\[datetime] The planned end-of-life date and time, when provided. formatdate-time Link to this property label: Optional\[str] A label identifying the permission group. Link to this property scopes: Optional\[str] The scope associated with the permission group. Link to this property visibility: Optional\[str] Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: Optional\[str] Name of the permission group. Link to this property
Link to this property
resources: Union\[Dict\[str, str], Dict\[str, Dict\[str, str]]] A list of resource names that the policy applies to. One of the following: Dict\[str, str] Map of simple string resource permissions Link to this property Dict\[str, Dict\[str, str]] Map of nested resource permissions Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_policy%20%3E%20(schema)>) str The token value. [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_value%20%3E%20(schema)>)