snippets

package
v6.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

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.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

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.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

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.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type ContentGetParams 

type ContentGetParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ContentService 

type ContentService struct {
	Options []option.RequestOption
}

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

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewContentService method instead.

func NewContentService 

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

NewContentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ContentService) Get 

func (r *ContentService) Get(ctx context.Context, snippetName string, query ContentGetParams, opts ...option.RequestOption) (res *http.Response, err error)

Fetches the content of a snippet belonging to the zone.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type RuleDeleteParams 

type RuleDeleteParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type RuleDeleteResponse 

type RuleDeleteResponse struct {
	// The unique ID of the rule.
	ID string `json:"id,required"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression,required"`
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated,required" format:"date-time"`
	// The identifying name of the snippet.
	SnippetName string `json:"snippet_name,required"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool                   `json:"enabled"`
	JSON    ruleDeleteResponseJSON `json:"-"`
}

A snippet rule.

func (*RuleDeleteResponse) UnmarshalJSON 

func (r *RuleDeleteResponse) UnmarshalJSON(data []byte) (err error)

type RuleListParams 

type RuleListParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type RuleListResponse 

type RuleListResponse struct {
	// The unique ID of the rule.
	ID string `json:"id,required"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression,required"`
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated,required" format:"date-time"`
	// The identifying name of the snippet.
	SnippetName string `json:"snippet_name,required"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool                 `json:"enabled"`
	JSON    ruleListResponseJSON `json:"-"`
}

A snippet rule.

func (*RuleListResponse) UnmarshalJSON 

func (r *RuleListResponse) UnmarshalJSON(data []byte) (err error)

type RuleService 

type RuleService struct {
	Options []option.RequestOption
}

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

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRuleService method instead.

func NewRuleService 

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

NewRuleService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*RuleService) Delete 

func (r *RuleService) Delete(ctx context.Context, body RuleDeleteParams, opts ...option.RequestOption) (res *pagination.SinglePage[RuleDeleteResponse], err error)

Deletes all snippet rules belonging to the zone.

func (*RuleService) DeleteAutoPaging 

func (r *RuleService) DeleteAutoPaging(ctx context.Context, body RuleDeleteParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleDeleteResponse]

Deletes all snippet rules belonging to the zone.

func (*RuleService) List 

func (r *RuleService) List(ctx context.Context, query RuleListParams, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], err error)

Fetches all snippet rules belonging to the zone.

func (*RuleService) ListAutoPaging 

func (r *RuleService) ListAutoPaging(ctx context.Context, query RuleListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse]

Fetches all snippet rules belonging to the zone.

func (*RuleService) Update 

func (r *RuleService) Update(ctx context.Context, params RuleUpdateParams, opts ...option.RequestOption) (res *pagination.SinglePage[RuleUpdateResponse], err error)

Updates all snippet rules belonging to the zone.

func (*RuleService) UpdateAutoPaging 

func (r *RuleService) UpdateAutoPaging(ctx context.Context, params RuleUpdateParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleUpdateResponse]

Updates all snippet rules belonging to the zone.

type RuleUpdateParams 

type RuleUpdateParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// A list of snippet rules.
	Rules param.Field[[]RuleUpdateParamsRule] `json:"rules,required"`
}

func (RuleUpdateParams) MarshalJSON 

func (r RuleUpdateParams) MarshalJSON() (data []byte, err error)

type RuleUpdateParamsRule 

type RuleUpdateParamsRule struct {
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression,required"`
	// The identifying name of the snippet.
	SnippetName param.Field[string] `json:"snippet_name,required"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
}

A snippet rule.

func (RuleUpdateParamsRule) MarshalJSON 

func (r RuleUpdateParamsRule) MarshalJSON() (data []byte, err error)

type RuleUpdateResponse 

type RuleUpdateResponse struct {
	// The unique ID of the rule.
	ID string `json:"id,required"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression,required"`
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated,required" format:"date-time"`
	// The identifying name of the snippet.
	SnippetName string `json:"snippet_name,required"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool                   `json:"enabled"`
	JSON    ruleUpdateResponseJSON `json:"-"`
}

A snippet rule.

func (*RuleUpdateResponse) UnmarshalJSON 

func (r *RuleUpdateResponse) UnmarshalJSON(data []byte) (err error)

type SnippetDeleteParams 

type SnippetDeleteParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type SnippetDeleteResponseEnvelope 

type SnippetDeleteResponseEnvelope struct {
	// A list of error messages.
	Errors []SnippetDeleteResponseEnvelopeErrors `json:"errors,required"`
	// A list of warning messages.
	Messages []SnippetDeleteResponseEnvelopeMessages `json:"messages,required"`
	// A result.
	Result string `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success SnippetDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    snippetDeleteResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*SnippetDeleteResponseEnvelope) UnmarshalJSON 

func (r *SnippetDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SnippetDeleteResponseEnvelopeErrors 

type SnippetDeleteResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message,required"`
	// A unique code for this message.
	Code int64                                   `json:"code"`
	JSON snippetDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

A message.

func (*SnippetDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *SnippetDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SnippetDeleteResponseEnvelopeMessages 

type SnippetDeleteResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message,required"`
	// A unique code for this message.
	Code int64                                     `json:"code"`
	JSON snippetDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

A message.

func (*SnippetDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *SnippetDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SnippetDeleteResponseEnvelopeSuccess 

type SnippetDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SnippetDeleteResponseEnvelopeSuccessTrue SnippetDeleteResponseEnvelopeSuccess = true
)

func (SnippetDeleteResponseEnvelopeSuccess) IsKnown 

func (r SnippetDeleteResponseEnvelopeSuccess) IsKnown() bool

type SnippetGetParams 

type SnippetGetParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type SnippetGetResponse 

type SnippetGetResponse struct {
	// The timestamp of when the snippet was created.
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// The identifying name of the snippet.
	SnippetName string `json:"snippet_name,required"`
	// The timestamp of when the snippet was last modified.
	ModifiedOn time.Time              `json:"modified_on" format:"date-time"`
	JSON       snippetGetResponseJSON `json:"-"`
}

A result.

func (*SnippetGetResponse) UnmarshalJSON 

func (r *SnippetGetResponse) UnmarshalJSON(data []byte) (err error)

type SnippetGetResponseEnvelope 

type SnippetGetResponseEnvelope struct {
	// A list of error messages.
	Errors []SnippetGetResponseEnvelopeErrors `json:"errors,required"`
	// A list of warning messages.
	Messages []SnippetGetResponseEnvelopeMessages `json:"messages,required"`
	// A result.
	Result SnippetGetResponse `json:"result,required"`
	// Whether the API call was successful.
	Success SnippetGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    snippetGetResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*SnippetGetResponseEnvelope) UnmarshalJSON 

func (r *SnippetGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SnippetGetResponseEnvelopeErrors 

type SnippetGetResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message,required"`
	// A unique code for this message.
	Code int64                                `json:"code"`
	JSON snippetGetResponseEnvelopeErrorsJSON `json:"-"`
}

A message.

func (*SnippetGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *SnippetGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SnippetGetResponseEnvelopeMessages 

type SnippetGetResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message,required"`
	// A unique code for this message.
	Code int64                                  `json:"code"`
	JSON snippetGetResponseEnvelopeMessagesJSON `json:"-"`
}

A message.

func (*SnippetGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *SnippetGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SnippetGetResponseEnvelopeSuccess 

type SnippetGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SnippetGetResponseEnvelopeSuccessTrue SnippetGetResponseEnvelopeSuccess = true
)

func (SnippetGetResponseEnvelopeSuccess) IsKnown 

func (r SnippetGetResponseEnvelopeSuccess) IsKnown() bool

type SnippetListParams 

type SnippetListParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The current page number.
	Page param.Field[int64] `query:"page"`
	// The number of results to return per page.
	PerPage param.Field[int64] `query:"per_page"`
}

func (SnippetListParams) URLQuery 

func (r SnippetListParams) URLQuery() (v url.Values)

URLQuery serializes SnippetListParams's query parameters as `url.Values`.

type SnippetListResponse 

type SnippetListResponse struct {
	// The timestamp of when the snippet was created.
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// The identifying name of the snippet.
	SnippetName string `json:"snippet_name,required"`
	// The timestamp of when the snippet was last modified.
	ModifiedOn time.Time               `json:"modified_on" format:"date-time"`
	JSON       snippetListResponseJSON `json:"-"`
}

A snippet object.

func (*SnippetListResponse) UnmarshalJSON 

func (r *SnippetListResponse) UnmarshalJSON(data []byte) (err error)

type SnippetService 

type SnippetService struct {
	Options []option.RequestOption
	Content *ContentService
	Rules   *RuleService
}

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

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSnippetService method instead.

func NewSnippetService 

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

NewSnippetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SnippetService) Delete 

func (r *SnippetService) Delete(ctx context.Context, snippetName string, body SnippetDeleteParams, opts ...option.RequestOption) (res *string, err error)

Deletes a snippet belonging to the zone.

func (*SnippetService) Get 

func (r *SnippetService) Get(ctx context.Context, snippetName string, query SnippetGetParams, opts ...option.RequestOption) (res *SnippetGetResponse, err error)

Fetches a snippet belonging to the zone.

func (*SnippetService) List 

func (r *SnippetService) List(ctx context.Context, params SnippetListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SnippetListResponse], err error)

Fetches all snippets belonging to the zone.

func (*SnippetService) ListAutoPaging 

func (r *SnippetService) ListAutoPaging(ctx context.Context, params SnippetListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SnippetListResponse]

Fetches all snippets belonging to the zone.

func (*SnippetService) Update 

func (r *SnippetService) Update(ctx context.Context, snippetName string, params SnippetUpdateParams, opts ...option.RequestOption) (res *SnippetUpdateResponse, err error)

Creates or updates a snippet belonging to the zone.

type SnippetUpdateParams 

type SnippetUpdateParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Metadata about the snippet.
	Metadata param.Field[SnippetUpdateParamsMetadata] `json:"metadata,required"`
}

func (SnippetUpdateParams) MarshalMultipart 

func (r SnippetUpdateParams) MarshalMultipart() (data []byte, contentType string, err error)

type SnippetUpdateParamsMetadata 

type SnippetUpdateParamsMetadata struct {
	// Name of the file that contains the main module of the snippet.
	MainModule param.Field[string] `json:"main_module,required"`
}

Metadata about the snippet.

func (SnippetUpdateParamsMetadata) MarshalJSON 

func (r SnippetUpdateParamsMetadata) MarshalJSON() (data []byte, err error)

type SnippetUpdateResponse 

type SnippetUpdateResponse struct {
	// The timestamp of when the snippet was created.
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// The identifying name of the snippet.
	SnippetName string `json:"snippet_name,required"`
	// The timestamp of when the snippet was last modified.
	ModifiedOn time.Time                 `json:"modified_on" format:"date-time"`
	JSON       snippetUpdateResponseJSON `json:"-"`
}

A result.

func (*SnippetUpdateResponse) UnmarshalJSON 

func (r *SnippetUpdateResponse) UnmarshalJSON(data []byte) (err error)

type SnippetUpdateResponseEnvelope 

type SnippetUpdateResponseEnvelope struct {
	// A list of error messages.
	Errors []SnippetUpdateResponseEnvelopeErrors `json:"errors,required"`
	// A list of warning messages.
	Messages []SnippetUpdateResponseEnvelopeMessages `json:"messages,required"`
	// A result.
	Result SnippetUpdateResponse `json:"result,required"`
	// Whether the API call was successful.
	Success SnippetUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    snippetUpdateResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*SnippetUpdateResponseEnvelope) UnmarshalJSON 

func (r *SnippetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SnippetUpdateResponseEnvelopeErrors 

type SnippetUpdateResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message,required"`
	// A unique code for this message.
	Code int64                                   `json:"code"`
	JSON snippetUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

A message.

func (*SnippetUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *SnippetUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SnippetUpdateResponseEnvelopeMessages 

type SnippetUpdateResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message,required"`
	// A unique code for this message.
	Code int64                                     `json:"code"`
	JSON snippetUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

A message.

func (*SnippetUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *SnippetUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SnippetUpdateResponseEnvelopeSuccess 

type SnippetUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SnippetUpdateResponseEnvelopeSuccessTrue SnippetUpdateResponseEnvelopeSuccess = true
)

func (SnippetUpdateResponseEnvelopeSuccess) IsKnown 

func (r SnippetUpdateResponseEnvelopeSuccess) IsKnown() bool

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.