const AuditLogActorTypeAdmin =shared.AuditLogActorTypeAdmin

const AuditLogActorTypeCloudflare =shared.AuditLogActorTypeCloudflare

const AuditLogActorTypeUser =shared.AuditLogActorTypeUser

const CertificateCADigicert =shared.CertificateCADigicert

const CertificateCAGoogle =shared.CertificateCAGoogle

const CertificateCALetsEncrypt =shared.CertificateCALetsEncrypt

const CertificateCASSLCom =shared.CertificateCASSLCom

const CertificateRequestTypeKeylessCertificate =shared.CertificateRequestTypeKeylessCertificate

const CertificateRequestTypeOriginECC =shared.CertificateRequestTypeOriginECC

const CertificateRequestTypeOriginRSA =shared.CertificateRequestTypeOriginRSA

const CloudflareTunnelStatusDegraded =shared.CloudflareTunnelStatusDegraded

const CloudflareTunnelStatusDown =shared.CloudflareTunnelStatusDown

const CloudflareTunnelStatusHealthy =shared.CloudflareTunnelStatusHealthy

const CloudflareTunnelStatusInactive =shared.CloudflareTunnelStatusInactive

const CloudflareTunnelTunTypeCNI =shared.CloudflareTunnelTunTypeCNI

const CloudflareTunnelTunTypeCfdTunnel =shared.CloudflareTunnelTunTypeCfdTunnel

const CloudflareTunnelTunTypeGRE =shared.CloudflareTunnelTunTypeGRE

const CloudflareTunnelTunTypeIPSec =shared.CloudflareTunnelTunTypeIPSec

const CloudflareTunnelTunTypeMagic =shared.CloudflareTunnelTunTypeMagic

const CloudflareTunnelTunTypeWARP =shared.CloudflareTunnelTunTypeWARP

const CloudflareTunnelTunTypeWARPConnector =shared.CloudflareTunnelTunTypeWARPConnector

const MemberPoliciesAccessAllow =shared.MemberPoliciesAccessAllow

const MemberPoliciesAccessDeny =shared.MemberPoliciesAccessDeny

const MemberStatusAccepted =shared.MemberStatusAccepted

const MemberStatusPending =shared.MemberStatusPending

const RatePlanIDBusiness =shared.RatePlanIDBusiness

const RatePlanIDEnterprise =shared.RatePlanIDEnterprise

const RatePlanIDFree =shared.RatePlanIDFree

const RatePlanIDLite =shared.RatePlanIDLite

const RatePlanIDPartnersBusiness =shared.RatePlanIDPartnersBusiness

const RatePlanIDPartnersEnterprise =shared.RatePlanIDPartnersEnterprise

const RatePlanIDPartnersFree =shared.RatePlanIDPartnersFree

const RatePlanIDPartnersPro =shared.RatePlanIDPartnersPro

const RatePlanIDPro =shared.RatePlanIDPro

const RatePlanIDProPlus =shared.RatePlanIDProPlus

const SortDirectionAsc =shared.SortDirectionAsc

const SortDirectionDesc =shared.SortDirectionDesc

const SubscriptionFrequencyMonthly =shared.SubscriptionFrequencyMonthly

const SubscriptionFrequencyQuarterly =shared.SubscriptionFrequencyQuarterly

const SubscriptionFrequencyWeekly =shared.SubscriptionFrequencyWeekly

const SubscriptionFrequencyYearly =shared.SubscriptionFrequencyYearly

const SubscriptionStateAwaitingPayment =shared.SubscriptionStateAwaitingPayment

const SubscriptionStateCancelled =shared.SubscriptionStateCancelled

const SubscriptionStateExpired =shared.SubscriptionStateExpired

const SubscriptionStateFailed =shared.SubscriptionStateFailed

const SubscriptionStatePaid =shared.SubscriptionStatePaid

const SubscriptionStateProvisioned =shared.SubscriptionStateProvisioned

const SubscriptionStateTrial =shared.SubscriptionStateTrial

const TokenPolicyEffectAllow =shared.TokenPolicyEffectAllow

const TokenPolicyEffectDeny =shared.TokenPolicyEffectDeny

const TokenStatusActive =shared.TokenStatusActive

const TokenStatusDisabled =shared.TokenStatusDisabled

const TokenStatusExpired =shared.TokenStatusExpired

typeASN¶

type ASN =shared.ASN

This is an alias to an internal type.

typeASNParam¶

type ASNParam =shared.ASNParam

This is an alias to an internal type.

typeAuditLog¶

type AuditLog =shared.AuditLog

This is an alias to an internal type.

typeAuditLogAction¶

type AuditLogAction =shared.AuditLogAction

This is an alias to an internal type.

typeAuditLogActor¶

type AuditLogActor =shared.AuditLogActor

This is an alias to an internal type.

typeAuditLogActorType¶

type AuditLogActorType =shared.AuditLogActorType

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

This is an alias to an internal type.

typeAuditLogOwner¶

type AuditLogOwner =shared.AuditLogOwner

This is an alias to an internal type.

typeAuditLogResource¶

type AuditLogResource =shared.AuditLogResource

This is an alias to an internal type.

typeCertificateCA¶

type CertificateCA =shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

typeCertificateRequestType¶

type CertificateRequestType =shared.CertificateRequestType

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

This is an alias to an internal type.

typeCloudflareTunnel¶

type CloudflareTunnel =shared.CloudflareTunnel

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

This is an alias to an internal type.

typeCloudflareTunnelConnection¶

type CloudflareTunnelConnection =shared.CloudflareTunnelConnection

This is an alias to an internal type.

typeCloudflareTunnelStatus¶

type CloudflareTunnelStatus =shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never beenrun), `degraded` (tunnel is active and able to serve traffic but in an unhealthystate), `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).

This is an alias to an internal type.

typeCloudflareTunnelTunType¶

type CloudflareTunnelTunType =shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

typeContentGetParams¶

type ContentGetParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`}

typeContentService¶

type ContentService struct {Options []option.RequestOption}

ContentService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewContentService method instead.

func NewContentService(opts ...option.RequestOption) (r *ContentService)

func (r *ContentService) Get(ctxcontext.Context, snippetNamestring, queryContentGetParams, opts ...option.RequestOption) (res *http.Response, errerror)

typeError¶

type Error =apierror.Error

typeErrorData¶

type ErrorData =shared.ErrorData

This is an alias to an internal type.

typeErrorDataSource¶added inv4.2.0

type ErrorDataSource =shared.ErrorDataSource

This is an alias to an internal type.

typeMember¶

type Member =shared.Member

This is an alias to an internal type.

typeMemberPoliciesAccess¶

type MemberPoliciesAccess =shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroup¶

type MemberPoliciesPermissionGroup =shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroupsMeta¶

type MemberPoliciesPermissionGroupsMeta =shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroup¶

type MemberPoliciesResourceGroup =shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsMeta¶

type MemberPoliciesResourceGroupsMeta =shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScope¶

type MemberPoliciesResourceGroupsScope =shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScopeObject¶

type MemberPoliciesResourceGroupsScopeObject =shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied againstinvite.

This is an alias to an internal type.

typeMemberPolicy¶

type MemberPolicy =shared.MemberPolicy

This is an alias to an internal type.

typeMemberStatus¶

type MemberStatus =shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

typeMemberUser¶

type MemberUser =shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

typePermission¶

type Permission =shared.Permission

This is an alias to an internal type.

typePermissionGrant¶

type PermissionGrant =shared.PermissionGrant

This is an alias to an internal type.

typePermissionGrantParam¶

type PermissionGrantParam =shared.PermissionGrantParam

This is an alias to an internal type.

typeRatePlan¶

type RatePlan =shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

typeRatePlanID¶added inv4.1.0

type RatePlanID =shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

typeRatePlanParam¶

type RatePlanParam =shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

typeResponseInfo¶

type ResponseInfo =shared.ResponseInfo

This is an alias to an internal type.

typeResponseInfoSource¶added inv4.3.0

type ResponseInfoSource =shared.ResponseInfoSource

This is an alias to an internal type.

typeRole¶

type Role =shared.Role

This is an alias to an internal type.

typeRoleParam¶

type RoleParam =shared.RoleParam

This is an alias to an internal type.

typeRolePermissions¶

type RolePermissions =shared.RolePermissions

This is an alias to an internal type.

typeRolePermissionsParam¶

type RolePermissionsParam =shared.RolePermissionsParam

This is an alias to an internal type.

typeRuleDeleteParams¶

type RuleDeleteParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`}

typeRuleDeleteResponse¶

type RuleDeleteResponse struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Whether the API call was successfulSuccessRuleDeleteResponseSuccess `json:"success,required"`JSON    ruleDeleteResponseJSON    `json:"-"`}

func (r *RuleDeleteResponse) UnmarshalJSON(data []byte) (errerror)

typeRuleDeleteResponseSuccess¶

type RuleDeleteResponseSuccessbool

Whether the API call was successful

const (RuleDeleteResponseSuccessTrueRuleDeleteResponseSuccess =true)

func (rRuleDeleteResponseSuccess) IsKnown()bool

typeRuleListParams¶

type RuleListParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`}

typeRuleListResponse¶

type RuleListResponse struct {Descriptionstring `json:"description"`Enabledbool   `json:"enabled"`Expressionstring `json:"expression"`// Snippet identifying nameSnippetNamestring               `json:"snippet_name"`JSON        ruleListResponseJSON `json:"-"`}

func (r *RuleListResponse) UnmarshalJSON(data []byte) (errerror)

typeRuleService¶

type RuleService struct {Options []option.RequestOption}

RuleService contains methods and other services that help with interacting withthe cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewRuleService method instead.

func NewRuleService(opts ...option.RequestOption) (r *RuleService)

func (r *RuleService) Delete(ctxcontext.Context, bodyRuleDeleteParams, opts ...option.RequestOption) (res *RuleDeleteResponse, errerror)

func (r *RuleService) List(ctxcontext.Context, queryRuleListParams, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], errerror)

func (r *RuleService) ListAutoPaging(ctxcontext.Context, queryRuleListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse]

func (r *RuleService) Update(ctxcontext.Context, paramsRuleUpdateParams, opts ...option.RequestOption) (res *pagination.SinglePage[RuleUpdateResponse], errerror)

func (r *RuleService) UpdateAutoPaging(ctxcontext.Context, paramsRuleUpdateParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleUpdateResponse]

typeRuleUpdateParams¶

type RuleUpdateParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`// List of snippet rulesRulesparam.Field[[]RuleUpdateParamsRule] `json:"rules"`}

func (rRuleUpdateParams) MarshalJSON() (data []byte, errerror)

typeRuleUpdateParamsRule¶

type RuleUpdateParamsRule struct {Descriptionparam.Field[string] `json:"description"`Enabledparam.Field[bool]   `json:"enabled"`Expressionparam.Field[string] `json:"expression"`// Snippet identifying nameSnippetNameparam.Field[string] `json:"snippet_name"`}

func (rRuleUpdateParamsRule) MarshalJSON() (data []byte, errerror)

typeRuleUpdateResponse¶

type RuleUpdateResponse struct {Descriptionstring `json:"description"`Enabledbool   `json:"enabled"`Expressionstring `json:"expression"`// Snippet identifying nameSnippetNamestring                 `json:"snippet_name"`JSON        ruleUpdateResponseJSON `json:"-"`}

func (r *RuleUpdateResponse) UnmarshalJSON(data []byte) (errerror)

typeSnippet¶

type Snippet struct {// Creation time of the snippetCreatedOnstring `json:"created_on"`// Modification time of the snippetModifiedOnstring `json:"modified_on"`// Snippet identifying nameSnippetNamestring      `json:"snippet_name"`JSON        snippetJSON `json:"-"`}

Snippet Information

func (r *Snippet) UnmarshalJSON(data []byte) (errerror)

typeSnippetDeleteParams¶

type SnippetDeleteParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`}

typeSnippetDeleteResponse¶

type SnippetDeleteResponse struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Whether the API call was successfulSuccessSnippetDeleteResponseSuccess `json:"success,required"`JSON    snippetDeleteResponseJSON    `json:"-"`}

func (r *SnippetDeleteResponse) UnmarshalJSON(data []byte) (errerror)

typeSnippetDeleteResponseSuccess¶

type SnippetDeleteResponseSuccessbool

Whether the API call was successful

const (SnippetDeleteResponseSuccessTrueSnippetDeleteResponseSuccess =true)

func (rSnippetDeleteResponseSuccess) IsKnown()bool

typeSnippetGetParams¶

type SnippetGetParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`}

typeSnippetGetResponseEnvelope¶

type SnippetGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Whether the API call was successfulSuccessSnippetGetResponseEnvelopeSuccess `json:"success,required"`// Snippet InformationResultSnippet                        `json:"result"`JSON   snippetGetResponseEnvelopeJSON `json:"-"`}

func (r *SnippetGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeSnippetGetResponseEnvelopeSuccess¶

type SnippetGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (SnippetGetResponseEnvelopeSuccessTrueSnippetGetResponseEnvelopeSuccess =true)

func (rSnippetGetResponseEnvelopeSuccess) IsKnown()bool

typeSnippetListParams¶

type SnippetListParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`}

typeSnippetService¶

type SnippetService struct {Options []option.RequestOptionContent *ContentServiceRules   *RuleService}

SnippetService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewSnippetService method instead.

func NewSnippetService(opts ...option.RequestOption) (r *SnippetService)

func (r *SnippetService) Delete(ctxcontext.Context, snippetNamestring, bodySnippetDeleteParams, opts ...option.RequestOption) (res *SnippetDeleteResponse, errerror)

func (r *SnippetService) Get(ctxcontext.Context, snippetNamestring, querySnippetGetParams, opts ...option.RequestOption) (res *Snippet, errerror)

func (r *SnippetService) List(ctxcontext.Context, querySnippetListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Snippet], errerror)

func (r *SnippetService) ListAutoPaging(ctxcontext.Context, querySnippetListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Snippet]

func (r *SnippetService) Update(ctxcontext.Context, snippetNamestring, paramsSnippetUpdateParams, opts ...option.RequestOption) (res *Snippet, errerror)

typeSnippetUpdateParams¶

type SnippetUpdateParams struct {// IdentifierZoneIDparam.Field[string] `path:"zone_id,required"`// Content files of uploaded snippetFilesparam.Field[string]                      `json:"files"`Metadataparam.Field[SnippetUpdateParamsMetadata] `json:"metadata"`}

func (rSnippetUpdateParams) MarshalMultipart() (data []byte, contentTypestring, errerror)

typeSnippetUpdateParamsMetadata¶

type SnippetUpdateParamsMetadata struct {// Main module name of uploaded snippetMainModuleparam.Field[string] `json:"main_module"`}

func (rSnippetUpdateParamsMetadata) MarshalJSON() (data []byte, errerror)

typeSnippetUpdateResponseEnvelope¶

type SnippetUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Whether the API call was successfulSuccessSnippetUpdateResponseEnvelopeSuccess `json:"success,required"`// Snippet InformationResultSnippet                           `json:"result"`JSON   snippetUpdateResponseEnvelopeJSON `json:"-"`}

func (r *SnippetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeSnippetUpdateResponseEnvelopeSuccess¶

type SnippetUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (SnippetUpdateResponseEnvelopeSuccessTrueSnippetUpdateResponseEnvelopeSuccess =true)

func (rSnippetUpdateResponseEnvelopeSuccess) IsKnown()bool

typeSortDirection¶

type SortDirection =shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

typeSubscription¶

type Subscription =shared.Subscription

This is an alias to an internal type.

typeSubscriptionFrequency¶

type SubscriptionFrequency =shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

typeSubscriptionParam¶

type SubscriptionParam =shared.SubscriptionParam

This is an alias to an internal type.

typeSubscriptionState¶

type SubscriptionState =shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

typeToken¶

type Token =shared.Token

This is an alias to an internal type.

typeTokenCondition¶

type TokenCondition =shared.TokenCondition

This is an alias to an internal type.

typeTokenConditionCIDRList¶

type TokenConditionCIDRList =shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionCIDRListParam¶

type TokenConditionCIDRListParam =shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionParam¶

type TokenConditionParam =shared.TokenConditionParam

This is an alias to an internal type.

typeTokenConditionRequestIP¶

type TokenConditionRequestIP =shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

typeTokenConditionRequestIPParam¶

type TokenConditionRequestIPParam =shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

typeTokenParam¶

type TokenParam =shared.TokenParam

This is an alias to an internal type.

typeTokenPolicy¶

type TokenPolicy =shared.TokenPolicy

This is an alias to an internal type.

typeTokenPolicyEffect¶

type TokenPolicyEffect =shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

typeTokenPolicyParam¶

type TokenPolicyParam =shared.TokenPolicyParam

This is an alias to an internal type.

typeTokenPolicyPermissionGroup¶

type TokenPolicyPermissionGroup =shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupParam¶

type TokenPolicyPermissionGroupParam =shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMeta¶

type TokenPolicyPermissionGroupsMeta =shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMetaParam¶

type TokenPolicyPermissionGroupsMetaParam =shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyResourcesMap¶added inv4.6.0

type TokenPolicyResourcesMap =shared.TokenPolicyResourcesMap

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesMapParam¶added inv4.6.0

type TokenPolicyResourcesMapParam =shared.TokenPolicyResourcesMapParam

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesUnion¶added inv4.6.0

type TokenPolicyResourcesUnion =shared.TokenPolicyResourcesUnion

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

typeTokenPolicyResourcesUnionParam¶added inv4.6.0

type TokenPolicyResourcesUnionParam =shared.TokenPolicyResourcesUnionParam

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

typeTokenStatus¶

type TokenStatus =shared.TokenStatus

Status of the token.

This is an alias to an internal type.

typeTokenValue¶

type TokenValue =shared.TokenValue

The token value.

This is an alias to an internal type.