# Shared ## Domain Types ### ASN - `ASN = number` ### Audit Log - `AuditLog` - `id?: string` A string that uniquely identifies the audit log. - `action?: Action` - `result?: boolean` A boolean that indicates if the action attempted was successful. - `type?: string` A short string that describes the action that was performed. - `actor?: Actor` - `id?: string` The ID of the actor that performed the action. If a user performed the action, this will be their User ID. - `email?: string` The email of the user that performed the action. - `ip?: string` The IP address of the request that performed the action. - `type?: "user" | "admin" | "Cloudflare"` The type of actor, whether a User, Cloudflare Admin, or an Automated System. - `"user"` - `"admin"` - `"Cloudflare"` - `interface?: string` The source of the event. - `metadata?: unknown` An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. - `newValue?: string` The new value of the resource that was modified. - `oldValue?: string` The value of the resource before it was modified. - `owner?: Owner` - `id?: string` Identifier - `resource?: Resource` - `id?: string` An identifier for the resource that was affected by the action. - `type?: string` A short string that describes the resource that was affected by the action. - `when?: string` A UTC RFC3339 timestamp that specifies when the action being logged occured. ### Certificate CA - `CertificateCA = "digicert" | "google" | "lets_encrypt" | "ssl_com"` The Certificate Authority that will issue the certificate - `"digicert"` - `"google"` - `"lets_encrypt"` - `"ssl_com"` ### Certificate Request Type - `CertificateRequestType = "origin-rsa" | "origin-ecc" | "keyless-certificate"` Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers). - `"origin-rsa"` - `"origin-ecc"` - `"keyless-certificate"` ### Cloudflare Tunnel - `CloudflareTunnel` A Cloudflare Tunnel that connects your origin to Cloudflare's edge. - `id?: string` UUID of the tunnel. - `account_tag?: string` Cloudflare account ID - `config_src?: "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. - `"local"` - `"cloudflare"` - `connections?: Array` The Cloudflare Tunnel connections between your origin and Cloudflare's edge. - `id?: string` UUID of the Cloudflare Tunnel connection. - `client_id?: string` UUID of the Cloudflare Tunnel connector. - `client_version?: string` The cloudflared version used to establish this connection. - `colo_name?: string` The Cloudflare data center used for this connection. - `is_pending_reconnect?: boolean` 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. - `opened_at?: string` Timestamp of when the connection was established. - `origin_ip?: string` The public IP address of the host running cloudflared. - `uuid?: string` UUID of the Cloudflare Tunnel connection. - `conns_active_at?: string` Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive. - `conns_inactive_at?: string` Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active. - `created_at?: string` Timestamp of when the resource was created. - `deleted_at?: string` Timestamp of when the resource was deleted. If `null`, the resource has not been deleted. - `metadata?: unknown` Metadata associated with the tunnel. - `name?: string` A user-friendly name for a tunnel. - `remote_config?: boolean` 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. - `status?: "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). - `"inactive"` - `"degraded"` - `"healthy"` - `"down"` - `tun_type?: "cfd_tunnel" | "warp_connector" | "warp" | 4 more` The type of tunnel. - `"cfd_tunnel"` - `"warp_connector"` - `"warp"` - `"magic"` - `"ip_sec"` - `"gre"` - `"cni"` ### Error Data - `ErrorData` - `code?: number` - `documentation_url?: string` - `message?: string` - `source?: Source` - `pointer?: string` ### Identifier - `Identifier` - `id?: string` Identifier. ### Load Balancer Preview - `LoadBalancerPreview` - `pools?: Record` Monitored pool IDs mapped to their respective names. - `preview_id?: string` ### Member - `Member` - `id?: string` Membership identifier tag. - `email?: string` The contact email address of the user. - `policies?: Array` Access policy for the membership - `id?: string` Policy identifier. - `access?: "allow" | "deny"` Allow or deny operations against the resources. - `"allow"` - `"deny"` - `permission_groups?: Array` A set of permission groups that are specified to the policy. - `id: string` Identifier of the permission group. - `meta?: Meta` Attributes associated to the permission group. - `key?: string` - `value?: string` - `name?: string` Name of the permission group. - `resource_groups?: Array` A list of resource groups that the policy applies to. - `id: string` Identifier of the resource group. - `scope: Array` The scope associated to the resource group - `key: string` This is a combination of pre-defined resource name and identifier (like Account ID etc.) - `objects: Array` 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.) - `meta?: Meta` Attributes associated to the resource group. - `key?: string` - `value?: string` - `name?: string` Name of the resource group. - `roles?: Array` Roles assigned to this Member. - `id: string` Role identifier tag. - `description: string` Description of role's permissions. - `name: string` Role name. - `permissions: Permissions` - `analytics?: PermissionGrant` - `read?: boolean` - `write?: boolean` - `billing?: PermissionGrant` - `cache_purge?: PermissionGrant` - `dns?: PermissionGrant` - `dns_records?: PermissionGrant` - `lb?: PermissionGrant` - `logs?: PermissionGrant` - `organization?: PermissionGrant` - `ssl?: PermissionGrant` - `waf?: PermissionGrant` - `zone_settings?: PermissionGrant` - `zones?: PermissionGrant` - `status?: "accepted" | "pending"` A member's status in the account. - `"accepted"` - `"pending"` - `user?: User` Details of the user associated to the membership. - `email: string` The contact email address of the user. - `id?: string` Identifier - `first_name?: string | null` User's first name - `last_name?: string | null` User's last name - `two_factor_authentication_enabled?: boolean` Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. ### Pagination Info - `PaginationInfo` - `count?: number` Total number of results for the requested service - `page?: number` Current page within paginated list of results - `per_page?: number` Number of results per page of results - `total_count?: number` Total results available without any search parameters ### Permission - `Permission = string` ### Permission Grant - `PermissionGrant` - `read?: boolean` - `write?: boolean` ### Rate Plan - `RatePlan` The rate plan applied to the subscription. - `id?: "free" | "lite" | "pro" | 7 more` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency?: string` The currency applied to the rate plan subscription. - `externally_managed?: boolean` Whether this rate plan is managed externally from Cloudflare. - `is_contract?: boolean` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name?: string` The full name of the rate plan. - `scope?: string` The scope that this rate plan applies to. - `sets?: Array` The list of sets this rate plan applies to. Returns array of strings. ### Response Info - `ResponseInfo` - `code: number` - `message: string` - `documentation_url?: string` - `source?: Source` - `pointer?: string` ### Result - `Result = UnionMember0 | AaaAPIResponseCommon` - `UnionMember0` - `errors?: Array` - `code: number` - `message: string` - `documentation_url?: string` - `source?: Source` - `pointer?: string` - `messages?: Array` - `code: number` - `message: string` - `documentation_url?: string` - `source?: Source` - `result?: Array` - `id?: string` A string that uniquely identifies the audit log. - `action?: Action` - `result?: boolean` A boolean that indicates if the action attempted was successful. - `type?: string` A short string that describes the action that was performed. - `actor?: Actor` - `id?: string` The ID of the actor that performed the action. If a user performed the action, this will be their User ID. - `email?: string` The email of the user that performed the action. - `ip?: string` The IP address of the request that performed the action. - `type?: "user" | "admin" | "Cloudflare"` The type of actor, whether a User, Cloudflare Admin, or an Automated System. - `"user"` - `"admin"` - `"Cloudflare"` - `interface?: string` The source of the event. - `metadata?: unknown` An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. - `newValue?: string` The new value of the resource that was modified. - `oldValue?: string` The value of the resource before it was modified. - `owner?: Owner` - `id?: string` Identifier - `resource?: Resource` - `id?: string` An identifier for the resource that was affected by the action. - `type?: string` A short string that describes the resource that was affected by the action. - `when?: string` A UTC RFC3339 timestamp that specifies when the action being logged occured. - `success?: boolean` - `AaaAPIResponseCommon` - `errors: Array` - `code: number` - `message: string` - `documentation_url?: string` - `source?: Source` - `messages: Array` - `code: number` - `message: string` - `documentation_url?: string` - `source?: Source` - `success: true` Whether the API call was successful - `true` ### Role - `Role` - `id: string` Role identifier tag. - `description: string` Description of role's permissions. - `name: string` Role name. - `permissions: Permissions` - `analytics?: PermissionGrant` - `read?: boolean` - `write?: boolean` - `billing?: PermissionGrant` - `cache_purge?: PermissionGrant` - `dns?: PermissionGrant` - `dns_records?: PermissionGrant` - `lb?: PermissionGrant` - `logs?: PermissionGrant` - `organization?: PermissionGrant` - `ssl?: PermissionGrant` - `waf?: PermissionGrant` - `zone_settings?: PermissionGrant` - `zones?: PermissionGrant` ### Sort Direction - `SortDirection = "asc" | "desc"` Direction to order DNS records in. - `"asc"` - `"desc"` ### Subscription - `Subscription` - `id?: string` Subscription identifier tag. - `currency?: string` The monetary unit in which pricing information is displayed. - `current_period_end?: string` The end of the current period and also when the next billing is due. - `current_period_start?: string` When the current billing period started. May match initial_period_start if this is the first period. - `frequency?: "weekly" | "monthly" | "quarterly" | "yearly"` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `price?: number` The price of the subscription that will be billed, in US dollars. - `rate_plan?: RatePlan` The rate plan applied to the subscription. - `id?: "free" | "lite" | "pro" | 7 more` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency?: string` The currency applied to the rate plan subscription. - `externally_managed?: boolean` Whether this rate plan is managed externally from Cloudflare. - `is_contract?: boolean` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name?: string` The full name of the rate plan. - `scope?: string` The scope that this rate plan applies to. - `sets?: Array` The list of sets this rate plan applies to. Returns array of strings. - `state?: "Trial" | "Provisioned" | "Paid" | 4 more` The state that the subscription is in. - `"Trial"` - `"Provisioned"` - `"Paid"` - `"AwaitingPayment"` - `"Cancelled"` - `"Failed"` - `"Expired"` ### Subscription Component - `SubscriptionComponent` A component value for a subscription. - `default?: number` The default amount assigned. - `name?: string` The name of the component value. - `price?: number` The unit price for the component value. - `value?: number` The amount of the component value assigned. ### Subscription Zone - `SubscriptionZone` A simple zone object. May have null properties if not a zone subscription. - `id?: string` Identifier - `name?: string` The domain name ### Token - `Token` - `id?: string` Token identifier tag. - `condition?: Condition` - `request_ip?: RequestIP` Client IP restrictions. - `in?: Array` List of IPv4/IPv6 CIDR addresses. - `not_in?: Array` List of IPv4/IPv6 CIDR addresses. - `expires_on?: string` The expiration time on or after which the JWT MUST NOT be accepted for processing. - `issued_on?: string` The time on which the token was created. - `last_used_on?: string` Last time the token was used. - `modified_on?: string` Last time the token was modified. - `name?: string` Token name. - `not_before?: string` The time before which the token MUST NOT be accepted for processing. - `policies?: Array` List of access policies assigned to the token. - `id: string` Policy identifier. - `effect: "allow" | "deny"` Allow or deny operations against the resources. - `"allow"` - `"deny"` - `permission_groups: Array` A set of permission groups that are specified to the policy. - `id: string` Identifier of the permission group. - `meta?: Meta` Attributes associated to the permission group. - `key?: string` - `value?: string` - `name?: string` Name of the permission group. - `resources: Record | Record>` A list of resource names that the policy applies to. - `Record` - `Record>` - `status?: "active" | "disabled" | "expired"` Status of the token. - `"active"` - `"disabled"` - `"expired"` ### Token Condition CIDR List - `TokenConditionCIDRList = string` IPv4/IPv6 CIDR. ### Token Policy - `TokenPolicy` - `id: string` Policy identifier. - `effect: "allow" | "deny"` Allow or deny operations against the resources. - `"allow"` - `"deny"` - `permission_groups: Array` A set of permission groups that are specified to the policy. - `id: string` Identifier of the permission group. - `meta?: Meta` Attributes associated to the permission group. - `key?: string` - `value?: string` - `name?: string` Name of the permission group. - `resources: Record | Record>` A list of resource names that the policy applies to. - `Record` - `Record>` ### Token Value - `TokenValue = string` The token value.