Shared

ModelsExpand Collapse

type ASN int64

type AuditLog struct{…}

ID stringoptional

A string that uniquely identifies the audit log.

Action AuditLogActionoptional

Result booloptional

A boolean that indicates if the action attempted was successful.

Type stringoptional

A short string that describes the action that was performed.

Actor AuditLogActoroptional

ID stringoptional

The ID of the actor that performed the action. If a user performed the action, this will be their User ID.

Email stringoptional

The email of the user that performed the action.

formatemail

IP stringoptional

The IP address of the request that performed the action.

Type AuditLogActorTypeoptional

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

One of the following:

const AuditLogActorTypeUser AuditLogActorType = "user"

const AuditLogActorTypeAdmin AuditLogActorType = "admin"

const AuditLogActorTypeCloudflare AuditLogActorType = "Cloudflare"

Interface stringoptional

The source of the event.

Metadata unknownoptional

An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.

NewValue stringoptional

The new value of the resource that was modified.

OldValue stringoptional

The value of the resource before it was modified.

Owner AuditLogOwneroptional

ID stringoptional

Identifier

maxLength32

Resource AuditLogResourceoptional

ID stringoptional

An identifier for the resource that was affected by the action.

Type stringoptional

A short string that describes the resource that was affected by the action.

When Timeoptional

A UTC RFC3339 timestamp that specifies when the action being logged occured.

formatdate-time

type CertificateCA string

The Certificate Authority that will issue the certificate

One of the following:

const CertificateCADigicert CertificateCA = "digicert"

const CertificateCAGoogle CertificateCA = "google"

const CertificateCALetsEncrypt CertificateCA = "lets_encrypt"

const CertificateCASSLCom CertificateCA = "ssl_com"

type CertificateRequestType string

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

One of the following:

const CertificateRequestTypeOriginRSA CertificateRequestType = "origin-rsa"

const CertificateRequestTypeOriginECC CertificateRequestType = "origin-ecc"

const CertificateRequestTypeKeylessCertificate CertificateRequestType = "keyless-certificate"

type CloudflareTunnel struct{…}

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

ID stringoptional

UUID of the tunnel.

formatuuid

maxLength36

AccountTag stringoptional

Cloudflare account ID

maxLength32

ConfigSrc CloudflareTunnelConfigSrcoptional

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:

const CloudflareTunnelConfigSrcLocal CloudflareTunnelConfigSrc = "local"

const CloudflareTunnelConfigSrcCloudflare CloudflareTunnelConfigSrc = "cloudflare"

DeprecatedConnections []CloudflareTunnelConnectionoptional

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 stringoptional

UUID of the Cloudflare Tunnel connection.

formatuuid

maxLength36

ClientID stringoptional

UUID of the Cloudflare Tunnel connector.

formatuuid

maxLength36

ClientVersion stringoptional

The cloudflared version used to establish this connection.

ColoName stringoptional

The Cloudflare data center used for this connection.

IsPendingReconnect booloptional

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.

OpenedAt Timeoptional

Timestamp of when the connection was established.

formatdate-time

OriginIP stringoptional

The public IP address of the host running cloudflared.

UUID stringoptional

UUID of the Cloudflare Tunnel connection.

formatuuid

maxLength36

ConnsActiveAt Timeoptional

Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.

formatdate-time

ConnsInactiveAt Timeoptional

Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.

formatdate-time

CreatedAt Timeoptional

Timestamp of when the resource was created.

formatdate-time

DeletedAt Timeoptional

Timestamp of when the resource was deleted. If null, the resource has not been deleted.

formatdate-time

Metadata unknownoptional

Metadata associated with the tunnel.

Name stringoptional

A user-friendly name for a tunnel.

DeprecatedRemoteConfig booloptional

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.

Status CloudflareTunnelStatusoptional

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:

const CloudflareTunnelStatusInactive CloudflareTunnelStatus = "inactive"

const CloudflareTunnelStatusDegraded CloudflareTunnelStatus = "degraded"

const CloudflareTunnelStatusHealthy CloudflareTunnelStatus = "healthy"

const CloudflareTunnelStatusDown CloudflareTunnelStatus = "down"

TunType CloudflareTunnelTunTypeoptional

The type of tunnel.

One of the following:

const CloudflareTunnelTunTypeCfdTunnel CloudflareTunnelTunType = "cfd_tunnel"

const CloudflareTunnelTunTypeWARPConnector CloudflareTunnelTunType = "warp_connector"

const CloudflareTunnelTunTypeWARP CloudflareTunnelTunType = "warp"

const CloudflareTunnelTunTypeMagic CloudflareTunnelTunType = "magic"

const CloudflareTunnelTunTypeIPSec CloudflareTunnelTunType = "ip_sec"

const CloudflareTunnelTunTypeGRE CloudflareTunnelTunType = "gre"

const CloudflareTunnelTunTypeCNI CloudflareTunnelTunType = "cni"

type ErrorData struct{…}

Code int64optional

DocumentationURL stringoptional

Message stringoptional

Source ErrorDataSourceoptional

Pointer stringoptional

type Identifier struct{…}

ID stringoptional

Identifier.

maxLength32

type LoadBalancerPreview struct{…}

Pools map[string, string]optional

Monitored pool IDs mapped to their respective names.

PreviewID stringoptional

type Member struct{…}

ID stringoptional

Membership identifier tag.

maxLength32

Email stringoptional

The contact email address of the user.

maxLength90

Policies []MemberPolicyoptional

Access policy for the membership

ID stringoptional

Policy identifier.

Access MemberPoliciesAccessoptional

Allow or deny operations against the resources.

One of the following:

const MemberPoliciesAccessAllow MemberPoliciesAccess = "allow"

const MemberPoliciesAccessDeny MemberPoliciesAccess = "deny"

PermissionGroups []MemberPoliciesPermissionGroupoptional

A set of permission groups that are specified to the policy.

ID string

Identifier of the permission group.

Meta MemberPoliciesPermissionGroupsMetaoptional

Attributes associated to the permission group.

Key stringoptional

Value stringoptional

Name stringoptional

Name of the permission group.

ResourceGroups []MemberPoliciesResourceGroupoptional

A list of resource groups that the policy applies to.

ID string

Identifier of the resource group.

Scope []MemberPoliciesResourceGroupsScope

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 []MemberPoliciesResourceGroupsScopeObject

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 MemberPoliciesResourceGroupsMetaoptional

Attributes associated to the resource group.

Key stringoptional

Value stringoptional

Name stringoptional

Name of the resource group.

Roles []Roleoptional

Roles assigned to this Member.

ID string

Role identifier tag.

maxLength32

Description string

Description of role's permissions.

Name string

Role name.

maxLength120

Permissions RolePermissions

Analytics PermissionGrantoptional

Billing PermissionGrantoptional

CachePurge PermissionGrantoptional

DNS PermissionGrantoptional

DNSRecords PermissionGrantoptional

LB PermissionGrantoptional

Logs PermissionGrantoptional

Organization PermissionGrantoptional

SSL PermissionGrantoptional

WAF PermissionGrantoptional

ZoneSettings PermissionGrantoptional

Zones PermissionGrantoptional

Status MemberStatusoptional

A member's status in the account.

One of the following:

const MemberStatusAccepted MemberStatus = "accepted"

const MemberStatusPending MemberStatus = "pending"

User MemberUseroptional

Details of the user associated to the membership.

Email string

The contact email address of the user.

maxLength90

ID stringoptional

Identifier

maxLength32

minLength32

FirstName stringoptional

User's first name

maxLength60

LastName stringoptional

User's last name

maxLength60

TwoFactorAuthenticationEnabled booloptional

Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.

type PaginationInfo struct{…}

Count float64optional

Total number of results for the requested service

Page float64optional

Current page within paginated list of results

PerPage float64optional

Number of results per page of results

TotalCount float64optional

Total results available without any search parameters

type Permission string

type PermissionGrant struct{…}

Read booloptional

Write booloptional

type RatePlan struct{…}

The rate plan applied to the subscription.

ID RatePlanIDoptional

The ID of the rate plan.

One of the following:

const RatePlanIDFree RatePlanID = "free"

const RatePlanIDLite RatePlanID = "lite"

const RatePlanIDPro RatePlanID = "pro"

const RatePlanIDProPlus RatePlanID = "pro_plus"

const RatePlanIDBusiness RatePlanID = "business"

const RatePlanIDEnterprise RatePlanID = "enterprise"

const RatePlanIDPartnersFree RatePlanID = "partners_free"

const RatePlanIDPartnersPro RatePlanID = "partners_pro"

const RatePlanIDPartnersBusiness RatePlanID = "partners_business"

const RatePlanIDPartnersEnterprise RatePlanID = "partners_enterprise"

Currency stringoptional

The currency applied to the rate plan subscription.

ExternallyManaged booloptional

Whether this rate plan is managed externally from Cloudflare.

IsContract booloptional

Whether a rate plan is enterprise-based (or newly adopted term contract).

PublicName stringoptional

The full name of the rate plan.

Scope stringoptional

The scope that this rate plan applies to.

Sets []stringoptional

The list of sets this rate plan applies to. Returns array of strings.

type ResponseInfo struct{…}

Code int64

minimum1000

Message string

DocumentationURL stringoptional

Source ResponseInfoSourceoptional

Pointer stringoptional

type Result interface{…}

One of the following:

ResultObject

Errors []ResponseInfooptional

Code int64

minimum1000

Message string

DocumentationURL stringoptional

Source ResponseInfoSourceoptional

Pointer stringoptional

Messages []ResponseInfooptional

Code int64

minimum1000

Message string

DocumentationURL stringoptional

Source ResponseInfoSourceoptional

Pointer stringoptional

Result []AuditLogoptional

ID stringoptional

A string that uniquely identifies the audit log.

Action AuditLogActionoptional

Result booloptional

A boolean that indicates if the action attempted was successful.

Type stringoptional

A short string that describes the action that was performed.

Actor AuditLogActoroptional

ID stringoptional

The ID of the actor that performed the action. If a user performed the action, this will be their User ID.

Email stringoptional

The email of the user that performed the action.

formatemail

IP stringoptional

The IP address of the request that performed the action.

Type AuditLogActorTypeoptional

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

One of the following:

const AuditLogActorTypeUser AuditLogActorType = "user"

const AuditLogActorTypeAdmin AuditLogActorType = "admin"

const AuditLogActorTypeCloudflare AuditLogActorType = "Cloudflare"

Interface stringoptional

The source of the event.

Metadata unknownoptional

An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.

NewValue stringoptional

The new value of the resource that was modified.

OldValue stringoptional

The value of the resource before it was modified.

Owner AuditLogOwneroptional

ID stringoptional

Identifier

maxLength32

Resource AuditLogResourceoptional

ID stringoptional

An identifier for the resource that was affected by the action.

Type stringoptional

A short string that describes the resource that was affected by the action.

When Timeoptional

A UTC RFC3339 timestamp that specifies when the action being logged occured.

formatdate-time

Success booloptional

ResultAaaAPIResponseCommon

Errors []ResponseInfo

Code int64

minimum1000

Message string

DocumentationURL stringoptional

Source ResponseInfoSourceoptional

Pointer stringoptional

Messages []ResponseInfo

Code int64

minimum1000

Message string

DocumentationURL stringoptional

Source ResponseInfoSourceoptional

Pointer stringoptional

Success ResultAaaAPIResponseCommonSuccess

Whether the API call was successful

type Role struct{…}

ID string

Role identifier tag.

maxLength32

Description string

Description of role's permissions.

Name string

Role name.

maxLength120

Permissions RolePermissions

Analytics PermissionGrantoptional

Billing PermissionGrantoptional

CachePurge PermissionGrantoptional

DNS PermissionGrantoptional

DNSRecords PermissionGrantoptional

LB PermissionGrantoptional

Logs PermissionGrantoptional

Organization PermissionGrantoptional

SSL PermissionGrantoptional

WAF PermissionGrantoptional

ZoneSettings PermissionGrantoptional

Zones PermissionGrantoptional

type SortDirection string

Direction to order DNS records in.

One of the following:

const SortDirectionAsc SortDirection = "asc"

const SortDirectionDesc SortDirection = "desc"

type Subscription struct{…}

ID stringoptional

Subscription identifier tag.

maxLength32

Currency stringoptional

The monetary unit in which pricing information is displayed.

CurrentPeriodEnd Timeoptional

The end of the current period and also when the next billing is due.

formatdate-time

CurrentPeriodStart Timeoptional

When the current billing period started. May match initial_period_start if this is the first period.

formatdate-time

Frequency SubscriptionFrequencyoptional

How often the subscription is renewed automatically.

One of the following:

const SubscriptionFrequencyWeekly SubscriptionFrequency = "weekly"

const SubscriptionFrequencyMonthly SubscriptionFrequency = "monthly"

const SubscriptionFrequencyQuarterly SubscriptionFrequency = "quarterly"

const SubscriptionFrequencyYearly SubscriptionFrequency = "yearly"

Price float64optional

The price of the subscription that will be billed, in US dollars.

RatePlan RatePlanoptional

The rate plan applied to the subscription.

State SubscriptionStateoptional

The state that the subscription is in.

One of the following:

const SubscriptionStateTrial SubscriptionState = "Trial"

const SubscriptionStateProvisioned SubscriptionState = "Provisioned"

const SubscriptionStatePaid SubscriptionState = "Paid"

const SubscriptionStateAwaitingPayment SubscriptionState = "AwaitingPayment"

const SubscriptionStateCancelled SubscriptionState = "Cancelled"

const SubscriptionStateFailed SubscriptionState = "Failed"

const SubscriptionStateExpired SubscriptionState = "Expired"

type SubscriptionComponent struct{…}

A component value for a subscription.

Default float64optional

The default amount assigned.

Name stringoptional

The name of the component value.

Price float64optional

The unit price for the component value.

Value float64optional

The amount of the component value assigned.

type SubscriptionZone struct{…}

A simple zone object. May have null properties if not a zone subscription.

ID stringoptional

Identifier

maxLength32

Name stringoptional

The domain name

maxLength253

type Token struct{…}

ID stringoptional

Token identifier tag.

maxLength32

Condition TokenConditionoptional

RequestIP TokenConditionRequestIPoptional

Client IP restrictions.

In []TokenConditionCIDRListoptional

List of IPv4/IPv6 CIDR addresses.

NotIn []TokenConditionCIDRListoptional

List of IPv4/IPv6 CIDR addresses.

ExpiresOn Timeoptional

The expiration time on or after which the JWT MUST NOT be accepted for processing.

formatdate-time

IssuedOn Timeoptional

The time on which the token was created.

formatdate-time

LastUsedOn Timeoptional

Last time the token was used.

formatdate-time

ModifiedOn Timeoptional

Last time the token was modified.

formatdate-time

Name stringoptional

Token name.

maxLength120

NotBefore Timeoptional

The time before which the token MUST NOT be accepted for processing.

formatdate-time

Policies []TokenPolicyoptional

List of access policies assigned to the token.

ID string

Policy identifier.

Effect TokenPolicyEffect

Allow or deny operations against the resources.

One of the following:

const TokenPolicyEffectAllow TokenPolicyEffect = "allow"

const TokenPolicyEffectDeny TokenPolicyEffect = "deny"

PermissionGroups []TokenPolicyPermissionGroup

A set of permission groups that are specified to the policy.

ID string

Identifier of the permission group.

Meta TokenPolicyPermissionGroupsMetaoptional

Attributes associated to the permission group.

Key stringoptional

Value stringoptional

Name stringoptional

Name of the permission group.

Resources TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

One of the following:

type TokenPolicyResourcesIAMResourcesTypeObjectString map[string, string]

Map of simple string resource permissions

type TokenPolicyResourcesIAMResourcesTypeObjectNested map[string, map[string, string]]

Map of nested resource permissions

Status TokenStatusoptional

Status of the token.

One of the following:

const TokenStatusActive TokenStatus = "active"

const TokenStatusDisabled TokenStatus = "disabled"

const TokenStatusExpired TokenStatus = "expired"

type TokenConditionCIDRList string

IPv4/IPv6 CIDR.

type TokenPolicy struct{…}

ID string

Policy identifier.

Effect TokenPolicyEffect

Allow or deny operations against the resources.

One of the following:

const TokenPolicyEffectAllow TokenPolicyEffect = "allow"

const TokenPolicyEffectDeny TokenPolicyEffect = "deny"

PermissionGroups []TokenPolicyPermissionGroup

A set of permission groups that are specified to the policy.

ID string

Identifier of the permission group.

Meta TokenPolicyPermissionGroupsMetaoptional

Attributes associated to the permission group.

Key stringoptional

Value stringoptional

Name stringoptional

Name of the permission group.

Resources TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

One of the following:

type TokenPolicyResourcesIAMResourcesTypeObjectString map[string, string]

Map of simple string resource permissions

type TokenPolicyResourcesIAMResourcesTypeObjectNested map[string, map[string, string]]

Map of nested resource permissions

type TokenValue string

The token value.