--- title: Shared --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Shared ##### ModelsExpand Collapse ASN = number [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20asn%20%3E%20(schema)>)
AuditLog object {id, action, actor, 7 more } id: optional string A string that uniquely identifies the audit log. Link to this property
action: optional object {result, type } result: optional boolean A boolean that indicates if the action attempted was successful. Link to this property type: optional string A short string that describes the action that was performed. Link to this property
Link to this property
actor: optional object {id, email, ip, type } id: optional string 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 string The email of the user that performed the action. formatemail Link to this property ip: optional string The IP address of the request that performed the action. Link to this property
type: optional "user"or "admin"or "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 string The source of the event. Link to this property metadata: optional unknown 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 newValue: optional string The new value of the resource that was modified. Link to this property oldValue: optional string The value of the resource before it was modified. Link to this property
owner: optional object {id } id: optional string Identifier maxLength32 Link to this property
Link to this property
resource: optional object {id, type } id: optional string An identifier for the resource that was affected by the action. Link to this property type: optional string A short string that describes the resource that was affected by the action. Link to this property
Link to this property when: optional string 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)>)
CertificateCA = "digicert"or "google"or "lets\_encrypt"or "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)>)
CertificateRequestType = "origin-rsa"or "origin-ecc"or "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)>)
CloudflareTunnel object {id, account\_tag, config\_src, 10 more } A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. id: optional string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: optional string Cloudflare account ID maxLength32 Link to this property
config\_src: optional "local"or "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 array of object {id, client\_id, client\_version, 5 more } 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 string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: optional string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: optional string The cloudflared version used to establish this connection. Link to this property colo\_name: optional string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: optional boolean 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 string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: optional string The public IP address of the host running cloudflared. Link to this property uuid: optional string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: optional string 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 string 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 string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: optional string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: optional unknown Metadata associated with the tunnel. Link to this property name: optional string A user-friendly name for a tunnel. Link to this property Deprecatedremote\_config: optional boolean 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 "inactive"or "degraded"or "healthy"or "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 "cfd\_tunnel"or "warp\_connector"or "warp"or 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)>)
ErrorData object {code, documentation\_url, message, source } code: optional number Link to this property documentation\_url: optional string Link to this property message: optional string Link to this property
source: optional object {pointer } pointer: optional string 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)>)
Identifier object {id } id: optional string 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)>)
LoadBalancerPreview object {pools, preview\_id } pools: optional map\[string] Monitored pool IDs mapped to their respective names. Link to this property preview\_id: optional string Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20load_balancer_preview%20%3E%20(schema)>)
Member object {id, email, policies, 3 more } id: optional string Membership identifier tag. maxLength32 Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
policies: optional array of object {id, access, permission\_groups, resource\_groups } Access policy for the membership id: optional string Policy identifier. Link to this property
access: optional "allow"or "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 array of object {id, meta, name } A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta: optional object {category, deprecated, description, 5 more } Attributes associated to the permission group. category: optional string A category used to group permission groups. Link to this property deprecated: optional string Indicates whether the permission group is deprecated. Link to this property description: optional string Additional information about the permission group. Link to this property editable: optional string Indicates whether the permission group can be edited. Link to this property eol\_at: optional string The planned end-of-life date and time, when provided. formatdate-time Link to this property label: optional string A label identifying the permission group. Link to this property scopes: optional string The scope associated with the permission group. Link to this property visibility: optional string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: optional string Name of the permission group. Link to this property
Link to this property
resource\_groups: optional array of object {id, scope, meta, name } A list of resource groups that the policy applies to. id: string Identifier of the resource group. Link to this property
scope: object {key, objects } A scope is a combination of scope objects which provides additional context. key: string This is a combination of pre-defined resource name and identifier (like Account ID etc.) Link to this property
objects: array of object {key } A list of scope objects for additional context. key: string 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 object {key, value } Attributes associated to the resource group. key: optional string Link to this property value: optional string Link to this property
Link to this property name: optional string Name of the resource group. Link to this property
Link to this property
Link to this property
roles: optional array of Role { id, description, name, permissions } Roles assigned to this Member. id: string Role identifier tag. maxLength32 Link to this property description: string Description of role’s permissions. Link to this property name: string Role name. maxLength120 Link to this property
permissions: object {analytics, billing, cache\_purge, 9 more } analytics: optional PermissionGrant { read, write } Link to this property billing: optional PermissionGrant { read, write } Link to this property cache\_purge: optional PermissionGrant { read, write } Link to this property dns: optional PermissionGrant { read, write } Link to this property dns\_records: optional PermissionGrant { read, write } Link to this property lb: optional PermissionGrant { read, write } Link to this property logs: optional PermissionGrant { read, write } Link to this property organization: optional PermissionGrant { read, write } Link to this property ssl: optional PermissionGrant { read, write } Link to this property waf: optional PermissionGrant { read, write } Link to this property zone\_settings: optional PermissionGrant { read, write } Link to this property zones: optional PermissionGrant { read, write } Link to this property
Link to this property
Link to this property
status: optional "accepted"or "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 object {email, id, first\_name, 2 more } Details of the user associated to the membership. email: string The contact email address of the user. maxLength90 Link to this property id: optional string Identifier maxLength32 minLength32 Link to this property first\_name: optional string User’s first name maxLength60 Link to this property last\_name: optional string User’s last name maxLength60 Link to this property two\_factor\_authentication\_enabled: optional boolean 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)>)
PaginationInfo object {count, page, per\_page, total\_count } count: optional number Total number of results for the requested service Link to this property page: optional number Current page within paginated list of results Link to this property per\_page: optional number Number of results per page of results Link to this property total\_count: optional number 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)>) Permission = string [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20permission%20%3E%20(schema)>)
PermissionGrant object {read, write } read: optional boolean Link to this property write: optional boolean Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20permission_grant%20%3E%20(schema)>)
RatePlan object {id, currency, externally\_managed, 4 more } The rate plan applied to the subscription.
id: optional "free"or "lite"or "pro"or 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 string The currency applied to the rate plan subscription. Link to this property externally\_managed: optional boolean Whether this rate plan is managed externally from Cloudflare. Link to this property is\_contract: optional boolean Whether a rate plan is enterprise-based (or newly adopted term contract). Link to this property public\_name: optional string The full name of the rate plan. Link to this property scope: optional string The scope that this rate plan applies to. Link to this property sets: optional array of string 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)>)
ResponseInfo object {code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string 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 = object {errors, messages, result, success } or object {errors, messages, success } One of the following:
object {errors, messages, result, success }
errors: optional array of ResponseInfo { code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
Link to this property
messages: optional array of ResponseInfo { code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
Link to this property
result: optional array of AuditLog { id, action, actor, 7 more } id: optional string A string that uniquely identifies the audit log. Link to this property
action: optional object {result, type } result: optional boolean A boolean that indicates if the action attempted was successful. Link to this property type: optional string A short string that describes the action that was performed. Link to this property
Link to this property
actor: optional object {id, email, ip, type } id: optional string 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 string The email of the user that performed the action. formatemail Link to this property ip: optional string The IP address of the request that performed the action. Link to this property
type: optional "user"or "admin"or "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 string The source of the event. Link to this property metadata: optional unknown 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 newValue: optional string The new value of the resource that was modified. Link to this property oldValue: optional string The value of the resource before it was modified. Link to this property
owner: optional object {id } id: optional string Identifier maxLength32 Link to this property
Link to this property
resource: optional object {id, type } id: optional string An identifier for the resource that was affected by the action. Link to this property type: optional string A short string that describes the resource that was affected by the action. Link to this property
Link to this property when: optional string A UTC RFC3339 timestamp that specifies when the action being logged occured. formatdate-time Link to this property
Link to this property success: optional boolean Link to this property
Link to this property
AaaAPIResponseCommon object {errors, messages, success }
errors: array of ResponseInfo { code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
Link to this property
messages: array of ResponseInfo { code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
Link to this property success: 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)>)
Role object {id, description, name, permissions } id: string Role identifier tag. maxLength32 Link to this property description: string Description of role’s permissions. Link to this property name: string Role name. maxLength120 Link to this property
permissions: object {analytics, billing, cache\_purge, 9 more } analytics: optional PermissionGrant { read, write } Link to this property billing: optional PermissionGrant { read, write } Link to this property cache\_purge: optional PermissionGrant { read, write } Link to this property dns: optional PermissionGrant { read, write } Link to this property dns\_records: optional PermissionGrant { read, write } Link to this property lb: optional PermissionGrant { read, write } Link to this property logs: optional PermissionGrant { read, write } Link to this property organization: optional PermissionGrant { read, write } Link to this property ssl: optional PermissionGrant { read, write } Link to this property waf: optional PermissionGrant { read, write } Link to this property zone\_settings: optional PermissionGrant { read, write } Link to this property zones: optional PermissionGrant { read, write } Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20role%20%3E%20(schema)>)
SortDirection = "asc"or "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)>)
Subscription object {id, currency, current\_period\_end, 5 more } id: optional string Subscription identifier tag. maxLength32 Link to this property currency: optional string The monetary unit in which pricing information is displayed. Link to this property current\_period\_end: optional string The end of the current period and also when the next billing is due. formatdate-time Link to this property current\_period\_start: optional string 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 "weekly"or "monthly"or "quarterly"or "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 number The price of the subscription that will be billed, in US dollars. Link to this property rate\_plan: optional RatePlan { id, currency, externally\_managed, 4 more } The rate plan applied to the subscription. Link to this property
state: optional "Trial"or "Provisioned"or "Paid"or 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)>)
SubscriptionComponent object {default, display\_name, kind, 3 more } A component value for a subscription. default: optional number The default amount assigned. Link to this property display\_name: optional string A human-readable version of the component name. Link to this property
kind: optional "enum"or "sum"or "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 string The name of the component value. Link to this property price: optional number The unit price for the component value. Link to this property value: optional number 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)>)
SubscriptionZone object {id, name } A simple zone object. May have null properties if not a zone subscription. id: optional string Identifier maxLength32 Link to this property name: optional string 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)>)
Token object {id, condition, creator\_email\_at\_creation, 10 more } id: optional string Token identifier tag. maxLength32 Link to this property
condition: optional object {request\_ip }
request\_ip: optional object {in, not\_in } Client IP restrictions. in: optional array of TokenConditionCIDRList List of IPv4/IPv6 CIDR addresses. Link to this property not\_in: optional array of TokenConditionCIDRList List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property creator\_email\_at\_creation: optional string 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 string The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property issued\_on: optional string The time on which the token was created. formatdate-time Link to this property last\_used\_on: optional string Last time the token was used. formatdate-time Link to this property modified\_on: optional string Last time the token was modified. formatdate-time Link to this property name: optional string Token name. maxLength120 Link to this property not\_before: optional string The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
policies: optional array of TokenPolicy { id, effect, permission\_groups, resources } List of access policies assigned to the token. id: string Policy identifier. Link to this property
effect: "allow"or "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: array of object {id, meta, name } A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta: optional object {category, deprecated, description, 5 more } Attributes associated to the permission group. category: optional string A category used to group permission groups. Link to this property deprecated: optional string Indicates whether the permission group is deprecated. Link to this property description: optional string Additional information about the permission group. Link to this property editable: optional string Indicates whether the permission group can be edited. Link to this property eol\_at: optional string The planned end-of-life date and time, when provided. formatdate-time Link to this property label: optional string A label identifying the permission group. Link to this property scopes: optional string The scope associated with the permission group. Link to this property visibility: optional string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: optional string Name of the permission group. Link to this property
Link to this property
resources: map\[string]or map\[map\[string]] A list of resource names that the policy applies to. One of the following: IAMResourcesTypeObjectString = map\[string] Map of simple string resource permissions Link to this property IAMResourcesTypeObjectNested = map\[map\[string]] Map of nested resource permissions Link to this property
Link to this property
Link to this property provisioner\_id: optional string 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 string The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
status: optional "active"or "disabled"or "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)>) TokenConditionCIDRList = string IPv4/IPv6 CIDR. [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_condition_cidr_list%20%3E%20(schema)>)
TokenPolicy object {id, effect, permission\_groups, resources } id: string Policy identifier. Link to this property
effect: "allow"or "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: array of object {id, meta, name } A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta: optional object {category, deprecated, description, 5 more } Attributes associated to the permission group. category: optional string A category used to group permission groups. Link to this property deprecated: optional string Indicates whether the permission group is deprecated. Link to this property description: optional string Additional information about the permission group. Link to this property editable: optional string Indicates whether the permission group can be edited. Link to this property eol\_at: optional string The planned end-of-life date and time, when provided. formatdate-time Link to this property label: optional string A label identifying the permission group. Link to this property scopes: optional string The scope associated with the permission group. Link to this property visibility: optional string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: optional string Name of the permission group. Link to this property
Link to this property
resources: map\[string]or map\[map\[string]] A list of resource names that the policy applies to. One of the following: IAMResourcesTypeObjectString = map\[string] Map of simple string resource permissions Link to this property IAMResourcesTypeObjectNested = map\[map\[string]] 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)>) TokenValue = string The token value. [Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token_value%20%3E%20(schema)>)