Versions in this module Expand all Collapse all v3 v3.1.0 Sep 24, 2024 v3.0.1 Sep 23, 2024 Changes in this version + const AuditLogActorTypeAdmin + const AuditLogActorTypeCloudflare + const AuditLogActorTypeUser + const CertificateCADigicert + const CertificateCAGoogle + const CertificateCALetsEncrypt + const CertificateCASSLCom + const CertificateRequestTypeKeylessCertificate + const CertificateRequestTypeOriginECC + const CertificateRequestTypeOriginRSA + const CloudflareTunnelStatusDegraded + const CloudflareTunnelStatusDown + const CloudflareTunnelStatusHealthy + const CloudflareTunnelStatusInactive + const CloudflareTunnelTunTypeCNI + const CloudflareTunnelTunTypeCfdTunnel + const CloudflareTunnelTunTypeGRE + const CloudflareTunnelTunTypeIPSec + const CloudflareTunnelTunTypeWARPConnector + const MemberStatusAccepted + const MemberStatusPending + const SortDirectionAsc + const SortDirectionDesc + const SubscriptionFrequencyMonthly + const SubscriptionFrequencyQuarterly + const SubscriptionFrequencyWeekly + const SubscriptionFrequencyYearly + const SubscriptionStateAwaitingPayment + const SubscriptionStateCancelled + const SubscriptionStateExpired + const SubscriptionStateFailed + const SubscriptionStatePaid + const SubscriptionStateProvisioned + const SubscriptionStateTrial + type ASN = shared.ASN + type ASNParam = shared.ASNParam + type AuditLog = shared.AuditLog + type AuditLogAction = shared.AuditLogAction + type AuditLogActor = shared.AuditLogActor + type AuditLogActorType = shared.AuditLogActorType + type AuditLogOwner = shared.AuditLogOwner + type AuditLogResource = shared.AuditLogResource + type CachePurgeParams struct + Body CachePurgeParamsBodyUnion + ZoneID param.Field[string] + func (r CachePurgeParams) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBody struct + Files param.Field[interface{}] + Hosts param.Field[interface{}] + Prefixes param.Field[interface{}] + PurgeEverything param.Field[bool] + Tags param.Field[interface{}] + func (r CachePurgeParamsBody) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyCachePurgeEverything struct + PurgeEverything param.Field[bool] + func (r CachePurgeParamsBodyCachePurgeEverything) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyCachePurgeFlexPurgeByHostnames struct + Hosts param.Field[[]string] + func (r CachePurgeParamsBodyCachePurgeFlexPurgeByHostnames) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyCachePurgeFlexPurgeByPrefixes struct + Prefixes param.Field[[]string] + func (r CachePurgeParamsBodyCachePurgeFlexPurgeByPrefixes) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyCachePurgeFlexPurgeByTags struct + Tags param.Field[[]string] + func (r CachePurgeParamsBodyCachePurgeFlexPurgeByTags) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyCachePurgeSingleFile struct + Files param.Field[[]string] + func (r CachePurgeParamsBodyCachePurgeSingleFile) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeaders struct + Files param.Field[[]CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile] + func (r CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeaders) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile struct + Headers param.Field[interface{}] + URL param.Field[string] + func (r CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile) MarshalJSON() (data []byte, err error) + type CachePurgeParamsBodyUnion interface + type CachePurgeResponse struct + ID string + JSON cachePurgeResponseJSON + func (r *CachePurgeResponse) UnmarshalJSON(data []byte) (err error) + type CachePurgeResponseEnvelope struct + Errors []shared.ResponseInfo + JSON cachePurgeResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result CachePurgeResponse + Success CachePurgeResponseEnvelopeSuccess + func (r *CachePurgeResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type CachePurgeResponseEnvelopeSuccess bool + const CachePurgeResponseEnvelopeSuccessTrue + func (r CachePurgeResponseEnvelopeSuccess) IsKnown() bool + type CacheReserve string + const CacheReserveCacheReserve + func (r CacheReserve) IsKnown() bool + type CacheReserveClear string + const CacheReserveClearCacheReserveClear + func (r CacheReserveClear) IsKnown() bool + type CacheReserveClearParams struct + Body interface{} + ZoneID param.Field[string] + func (r CacheReserveClearParams) MarshalJSON() (data []byte, err error) + type CacheReserveClearResponse struct + EndTs time.Time + ID CacheReserveClear + JSON cacheReserveClearResponseJSON + ModifiedOn time.Time + StartTs time.Time + State State + func (r *CacheReserveClearResponse) UnmarshalJSON(data []byte) (err error) + type CacheReserveClearResponseEnvelope struct + Errors []shared.ResponseInfo + JSON cacheReserveClearResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result CacheReserveClearResponse + Success CacheReserveClearResponseEnvelopeSuccess + func (r *CacheReserveClearResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type CacheReserveClearResponseEnvelopeSuccess bool + const CacheReserveClearResponseEnvelopeSuccessTrue + func (r CacheReserveClearResponseEnvelopeSuccess) IsKnown() bool + type CacheReserveEditParams struct + Value param.Field[CacheReserveEditParamsValue] + ZoneID param.Field[string] + func (r CacheReserveEditParams) MarshalJSON() (data []byte, err error) + type CacheReserveEditParamsValue string + const CacheReserveEditParamsValueOff + const CacheReserveEditParamsValueOn + func (r CacheReserveEditParamsValue) IsKnown() bool + type CacheReserveEditResponse struct + ID CacheReserve + JSON cacheReserveEditResponseJSON + ModifiedOn time.Time + Value CacheReserveEditResponseValue + func (r *CacheReserveEditResponse) UnmarshalJSON(data []byte) (err error) + type CacheReserveEditResponseEnvelope struct + Errors []shared.ResponseInfo + JSON cacheReserveEditResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result CacheReserveEditResponse + Success CacheReserveEditResponseEnvelopeSuccess + func (r *CacheReserveEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type CacheReserveEditResponseEnvelopeSuccess bool + const CacheReserveEditResponseEnvelopeSuccessTrue + func (r CacheReserveEditResponseEnvelopeSuccess) IsKnown() bool + type CacheReserveEditResponseValue string + const CacheReserveEditResponseValueOff + const CacheReserveEditResponseValueOn + func (r CacheReserveEditResponseValue) IsKnown() bool + type CacheReserveGetParams struct + ZoneID param.Field[string] + type CacheReserveGetResponse struct + ID CacheReserve + JSON cacheReserveGetResponseJSON + ModifiedOn time.Time + Value CacheReserveGetResponseValue + func (r *CacheReserveGetResponse) UnmarshalJSON(data []byte) (err error) + type CacheReserveGetResponseEnvelope struct + Errors []shared.ResponseInfo + JSON cacheReserveGetResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result CacheReserveGetResponse + Success CacheReserveGetResponseEnvelopeSuccess + func (r *CacheReserveGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type CacheReserveGetResponseEnvelopeSuccess bool + const CacheReserveGetResponseEnvelopeSuccessTrue + func (r CacheReserveGetResponseEnvelopeSuccess) IsKnown() bool + type CacheReserveGetResponseValue string + const CacheReserveGetResponseValueOff + const CacheReserveGetResponseValueOn + func (r CacheReserveGetResponseValue) IsKnown() bool + type CacheReserveService struct + Options []option.RequestOption + func NewCacheReserveService(opts ...option.RequestOption) (r *CacheReserveService) + func (r *CacheReserveService) Clear(ctx context.Context, params CacheReserveClearParams, ...) (res *CacheReserveClearResponse, err error) + func (r *CacheReserveService) Edit(ctx context.Context, params CacheReserveEditParams, ...) (res *CacheReserveEditResponse, err error) + func (r *CacheReserveService) Get(ctx context.Context, query CacheReserveGetParams, opts ...option.RequestOption) (res *CacheReserveGetResponse, err error) + func (r *CacheReserveService) Status(ctx context.Context, query CacheReserveStatusParams, ...) (res *CacheReserveStatusResponse, err error) + type CacheReserveStatusParams struct + ZoneID param.Field[string] + type CacheReserveStatusResponse struct + EndTs time.Time + ID CacheReserveClear + JSON cacheReserveStatusResponseJSON + ModifiedOn time.Time + StartTs time.Time + State State + func (r *CacheReserveStatusResponse) UnmarshalJSON(data []byte) (err error) + type CacheReserveStatusResponseEnvelope struct + Errors []shared.ResponseInfo + JSON cacheReserveStatusResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result CacheReserveStatusResponse + Success CacheReserveStatusResponseEnvelopeSuccess + func (r *CacheReserveStatusResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type CacheReserveStatusResponseEnvelopeSuccess bool + const CacheReserveStatusResponseEnvelopeSuccessTrue + func (r CacheReserveStatusResponseEnvelopeSuccess) IsKnown() bool + type CacheService struct + CacheReserve *CacheReserveService + Options []option.RequestOption + RegionalTieredCache *RegionalTieredCacheService + SmartTieredCache *SmartTieredCacheService + Variants *VariantService + func NewCacheService(opts ...option.RequestOption) (r *CacheService) + func (r *CacheService) Purge(ctx context.Context, params CachePurgeParams, opts ...option.RequestOption) (res *CachePurgeResponse, err error) + type CacheVariant struct + ID CacheVariantIdentifier + JSON cacheVariantJSON + ModifiedOn time.Time + func (r *CacheVariant) UnmarshalJSON(data []byte) (err error) + type CacheVariantIdentifier string + const CacheVariantIdentifierVariants + func (r CacheVariantIdentifier) IsKnown() bool + type CertificateCA = shared.CertificateCA + type CertificateRequestType = shared.CertificateRequestType + type CloudflareTunnel = shared.CloudflareTunnel + type CloudflareTunnelConnection = shared.CloudflareTunnelConnection + type CloudflareTunnelStatus = shared.CloudflareTunnelStatus + type CloudflareTunnelTunType = shared.CloudflareTunnelTunType + type Error = apierror.Error + type ErrorData = shared.ErrorData + type MemberParam = shared.MemberParam + type MemberRoleParam = shared.MemberRoleParam + type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam + type MemberStatus = shared.MemberStatus + type MemberUserParam = shared.MemberUserParam + type Permission = shared.Permission + type PermissionGrant = shared.PermissionGrant + type PermissionGrantParam = shared.PermissionGrantParam + type RatePlan = shared.RatePlan + type RatePlanParam = shared.RatePlanParam + type RegionalTieredCache string + const RegionalTieredCacheTcRegional + func (r RegionalTieredCache) IsKnown() bool + type RegionalTieredCacheEditParams struct + Value param.Field[RegionalTieredCacheEditParamsValue] + ZoneID param.Field[string] + func (r RegionalTieredCacheEditParams) MarshalJSON() (data []byte, err error) + type RegionalTieredCacheEditParamsValue string + const RegionalTieredCacheEditParamsValueOff + const RegionalTieredCacheEditParamsValueOn + func (r RegionalTieredCacheEditParamsValue) IsKnown() bool + type RegionalTieredCacheEditResponse struct + ID RegionalTieredCache + JSON regionalTieredCacheEditResponseJSON + ModifiedOn time.Time + Value RegionalTieredCacheEditResponseValue + func (r *RegionalTieredCacheEditResponse) UnmarshalJSON(data []byte) (err error) + type RegionalTieredCacheEditResponseEnvelope struct + Errors []shared.ResponseInfo + JSON regionalTieredCacheEditResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result RegionalTieredCacheEditResponse + Success RegionalTieredCacheEditResponseEnvelopeSuccess + func (r *RegionalTieredCacheEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type RegionalTieredCacheEditResponseEnvelopeSuccess bool + const RegionalTieredCacheEditResponseEnvelopeSuccessTrue + func (r RegionalTieredCacheEditResponseEnvelopeSuccess) IsKnown() bool + type RegionalTieredCacheEditResponseValue struct + ID RegionalTieredCache + JSON regionalTieredCacheEditResponseValueJSON + ModifiedOn time.Time + func (r *RegionalTieredCacheEditResponseValue) UnmarshalJSON(data []byte) (err error) + type RegionalTieredCacheGetParams struct + ZoneID param.Field[string] + type RegionalTieredCacheGetResponse struct + ID RegionalTieredCache + JSON regionalTieredCacheGetResponseJSON + ModifiedOn time.Time + Value RegionalTieredCacheGetResponseValue + func (r *RegionalTieredCacheGetResponse) UnmarshalJSON(data []byte) (err error) + type RegionalTieredCacheGetResponseEnvelope struct + Errors []shared.ResponseInfo + JSON regionalTieredCacheGetResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result RegionalTieredCacheGetResponse + Success RegionalTieredCacheGetResponseEnvelopeSuccess + func (r *RegionalTieredCacheGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type RegionalTieredCacheGetResponseEnvelopeSuccess bool + const RegionalTieredCacheGetResponseEnvelopeSuccessTrue + func (r RegionalTieredCacheGetResponseEnvelopeSuccess) IsKnown() bool + type RegionalTieredCacheGetResponseValue struct + ID RegionalTieredCache + JSON regionalTieredCacheGetResponseValueJSON + ModifiedOn time.Time + func (r *RegionalTieredCacheGetResponseValue) UnmarshalJSON(data []byte) (err error) + type RegionalTieredCacheService struct + Options []option.RequestOption + func NewRegionalTieredCacheService(opts ...option.RequestOption) (r *RegionalTieredCacheService) + func (r *RegionalTieredCacheService) Edit(ctx context.Context, params RegionalTieredCacheEditParams, ...) (res *RegionalTieredCacheEditResponse, err error) + func (r *RegionalTieredCacheService) Get(ctx context.Context, query RegionalTieredCacheGetParams, ...) (res *RegionalTieredCacheGetResponse, err error) + type ResponseInfo = shared.ResponseInfo + type Role = shared.Role + type SmartTieredCacheDeleteParams struct + ZoneID param.Field[string] + type SmartTieredCacheDeleteResponse struct + Editable bool + ID string + JSON smartTieredCacheDeleteResponseJSON + ModifiedOn time.Time + Value SmartTieredCacheDeleteResponseValue + func (r *SmartTieredCacheDeleteResponse) UnmarshalJSON(data []byte) (err error) + type SmartTieredCacheDeleteResponseEnvelope struct + Errors []shared.ResponseInfo + JSON smartTieredCacheDeleteResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result SmartTieredCacheDeleteResponse + Success SmartTieredCacheDeleteResponseEnvelopeSuccess + func (r *SmartTieredCacheDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type SmartTieredCacheDeleteResponseEnvelopeSuccess bool + const SmartTieredCacheDeleteResponseEnvelopeSuccessTrue + func (r SmartTieredCacheDeleteResponseEnvelopeSuccess) IsKnown() bool + type SmartTieredCacheDeleteResponseValue string + const SmartTieredCacheDeleteResponseValueOff + const SmartTieredCacheDeleteResponseValueOn + func (r SmartTieredCacheDeleteResponseValue) IsKnown() bool + type SmartTieredCacheEditParams struct + Value param.Field[SmartTieredCacheEditParamsValue] + ZoneID param.Field[string] + func (r SmartTieredCacheEditParams) MarshalJSON() (data []byte, err error) + type SmartTieredCacheEditParamsValue string + const SmartTieredCacheEditParamsValueOff + const SmartTieredCacheEditParamsValueOn + func (r SmartTieredCacheEditParamsValue) IsKnown() bool + type SmartTieredCacheEditResponse struct + Editable bool + ID string + JSON smartTieredCacheEditResponseJSON + ModifiedOn time.Time + Value SmartTieredCacheEditResponseValue + func (r *SmartTieredCacheEditResponse) UnmarshalJSON(data []byte) (err error) + type SmartTieredCacheEditResponseEnvelope struct + Errors []shared.ResponseInfo + JSON smartTieredCacheEditResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result SmartTieredCacheEditResponse + Success SmartTieredCacheEditResponseEnvelopeSuccess + func (r *SmartTieredCacheEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type SmartTieredCacheEditResponseEnvelopeSuccess bool + const SmartTieredCacheEditResponseEnvelopeSuccessTrue + func (r SmartTieredCacheEditResponseEnvelopeSuccess) IsKnown() bool + type SmartTieredCacheEditResponseValue string + const SmartTieredCacheEditResponseValueOff + const SmartTieredCacheEditResponseValueOn + func (r SmartTieredCacheEditResponseValue) IsKnown() bool + type SmartTieredCacheGetParams struct + ZoneID param.Field[string] + type SmartTieredCacheGetResponse struct + Editable bool + ID string + JSON smartTieredCacheGetResponseJSON + ModifiedOn time.Time + Value SmartTieredCacheGetResponseValue + func (r *SmartTieredCacheGetResponse) UnmarshalJSON(data []byte) (err error) + type SmartTieredCacheGetResponseEnvelope struct + Errors []shared.ResponseInfo + JSON smartTieredCacheGetResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result SmartTieredCacheGetResponse + Success SmartTieredCacheGetResponseEnvelopeSuccess + func (r *SmartTieredCacheGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type SmartTieredCacheGetResponseEnvelopeSuccess bool + const SmartTieredCacheGetResponseEnvelopeSuccessTrue + func (r SmartTieredCacheGetResponseEnvelopeSuccess) IsKnown() bool + type SmartTieredCacheGetResponseValue string + const SmartTieredCacheGetResponseValueOff + const SmartTieredCacheGetResponseValueOn + func (r SmartTieredCacheGetResponseValue) IsKnown() bool + type SmartTieredCacheService struct + Options []option.RequestOption + func NewSmartTieredCacheService(opts ...option.RequestOption) (r *SmartTieredCacheService) + func (r *SmartTieredCacheService) Delete(ctx context.Context, body SmartTieredCacheDeleteParams, ...) (res *SmartTieredCacheDeleteResponse, err error) + func (r *SmartTieredCacheService) Edit(ctx context.Context, params SmartTieredCacheEditParams, ...) (res *SmartTieredCacheEditResponse, err error) + func (r *SmartTieredCacheService) Get(ctx context.Context, query SmartTieredCacheGetParams, ...) (res *SmartTieredCacheGetResponse, err error) + type SortDirection = shared.SortDirection + type State string + const StateCompleted + const StateInProgress + func (r State) IsKnown() bool + type Subscription = shared.Subscription + type SubscriptionFrequency = shared.SubscriptionFrequency + type SubscriptionParam = shared.SubscriptionParam + type SubscriptionState = shared.SubscriptionState + type VariantDeleteParams struct + ZoneID param.Field[string] + type VariantDeleteResponseEnvelope struct + Errors []shared.ResponseInfo + JSON variantDeleteResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result CacheVariant + Success VariantDeleteResponseEnvelopeSuccess + func (r *VariantDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type VariantDeleteResponseEnvelopeSuccess bool + const VariantDeleteResponseEnvelopeSuccessTrue + func (r VariantDeleteResponseEnvelopeSuccess) IsKnown() bool + type VariantEditParams struct + Value param.Field[VariantEditParamsValue] + ZoneID param.Field[string] + func (r VariantEditParams) MarshalJSON() (data []byte, err error) + type VariantEditParamsValue struct + AVIF param.Field[[]string] + BMP param.Field[[]string] + GIF param.Field[[]string] + JP2 param.Field[[]string] + JPEG param.Field[[]string] + JPG param.Field[[]string] + JPG2 param.Field[[]string] + PNG param.Field[[]string] + TIF param.Field[[]string] + TIFF param.Field[[]string] + WebP param.Field[[]string] + func (r VariantEditParamsValue) MarshalJSON() (data []byte, err error) + type VariantEditResponse struct + ID CacheVariantIdentifier + JSON variantEditResponseJSON + ModifiedOn time.Time + Value VariantEditResponseValue + func (r *VariantEditResponse) UnmarshalJSON(data []byte) (err error) + type VariantEditResponseEnvelope struct + Errors []shared.ResponseInfo + JSON variantEditResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result VariantEditResponse + Success VariantEditResponseEnvelopeSuccess + func (r *VariantEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type VariantEditResponseEnvelopeSuccess bool + const VariantEditResponseEnvelopeSuccessTrue + func (r VariantEditResponseEnvelopeSuccess) IsKnown() bool + type VariantEditResponseValue struct + AVIF []string + BMP []string + GIF []string + JP2 []string + JPEG []string + JPG []string + JPG2 []string + JSON variantEditResponseValueJSON + PNG []string + TIF []string + TIFF []string + WebP []string + func (r *VariantEditResponseValue) UnmarshalJSON(data []byte) (err error) + type VariantGetParams struct + ZoneID param.Field[string] + type VariantGetResponse struct + ID CacheVariantIdentifier + JSON variantGetResponseJSON + ModifiedOn time.Time + Value VariantGetResponseValue + func (r *VariantGetResponse) UnmarshalJSON(data []byte) (err error) + type VariantGetResponseEnvelope struct + Errors []shared.ResponseInfo + JSON variantGetResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result VariantGetResponse + Success VariantGetResponseEnvelopeSuccess + func (r *VariantGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type VariantGetResponseEnvelopeSuccess bool + const VariantGetResponseEnvelopeSuccessTrue + func (r VariantGetResponseEnvelopeSuccess) IsKnown() bool + type VariantGetResponseValue struct + AVIF []string + BMP []string + GIF []string + JP2 []string + JPEG []string + JPG []string + JPG2 []string + JSON variantGetResponseValueJSON + PNG []string + TIF []string + TIFF []string + WebP []string + func (r *VariantGetResponseValue) UnmarshalJSON(data []byte) (err error) + type VariantService struct + Options []option.RequestOption + func NewVariantService(opts ...option.RequestOption) (r *VariantService) + func (r *VariantService) Delete(ctx context.Context, body VariantDeleteParams, opts ...option.RequestOption) (res *CacheVariant, err error) + func (r *VariantService) Edit(ctx context.Context, params VariantEditParams, opts ...option.RequestOption) (res *VariantEditResponse, err error) + func (r *VariantService) Get(ctx context.Context, query VariantGetParams, opts ...option.RequestOption) (res *VariantGetResponse, err error) Other modules containing this package github.com/cloudflare/cloudflare-go/v2 github.com/cloudflare/cloudflare-go/v4 github.com/cloudflare/cloudflare-go/v5 github.com/cloudflare/cloudflare-go/v6