Versions in this module Expand all Collapse all v7 v7.3.0 May 20, 2026 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 CloudflareTunnelConfigSrcCloudflare + const CloudflareTunnelConfigSrcLocal + const CloudflareTunnelStatusDegraded + const CloudflareTunnelStatusDown + const CloudflareTunnelStatusHealthy + const CloudflareTunnelStatusInactive + const CloudflareTunnelTunTypeCNI + const CloudflareTunnelTunTypeCfdTunnel + const CloudflareTunnelTunTypeGRE + const CloudflareTunnelTunTypeIPSec + const CloudflareTunnelTunTypeMagic + const CloudflareTunnelTunTypeWARP + const CloudflareTunnelTunTypeWARPConnector + const MemberPoliciesAccessAllow + const MemberPoliciesAccessDeny + const MemberStatusAccepted + const MemberStatusPending + const RatePlanIDBusiness + const RatePlanIDEnterprise + const RatePlanIDFree + const RatePlanIDLite + const RatePlanIDPartnersBusiness + const RatePlanIDPartnersEnterprise + const RatePlanIDPartnersFree + const RatePlanIDPartnersPro + const RatePlanIDPro + const RatePlanIDProPlus + 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 + const TokenPolicyEffectAllow + const TokenPolicyEffectDeny + const TokenStatusActive + const TokenStatusDisabled + const TokenStatusExpired + 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 CertificateCA = shared.CertificateCA + type CertificateRequestType = shared.CertificateRequestType + type CloudflareTunnel = shared.CloudflareTunnel + type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc + type CloudflareTunnelConnection = shared.CloudflareTunnelConnection + type CloudflareTunnelStatus = shared.CloudflareTunnelStatus + type CloudflareTunnelTunType = shared.CloudflareTunnelTunType + type ConfigDeleteParams struct + AccountID param.Field[string] + type ConfigDeleteResponse = interface + type ConfigDeleteResponseEnvelope struct + Errors []shared.ResponseInfo + JSON configDeleteResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result ConfigDeleteResponse + Success ConfigDeleteResponseEnvelopeSuccess + func (r *ConfigDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type ConfigDeleteResponseEnvelopeSuccess bool + const ConfigDeleteResponseEnvelopeSuccessTrue + func (r ConfigDeleteResponseEnvelopeSuccess) IsKnown() bool + type ConfigEditParams struct + AccountID param.Field[string] + Caching param.Field[ConfigEditParamsCachingUnion] + MTLS param.Field[ConfigEditParamsMTLS] + Name param.Field[string] + Origin param.Field[ConfigEditParamsOriginUnion] + OriginConnectionLimit param.Field[int64] + func (r ConfigEditParams) MarshalJSON() (data []byte, err error) + type ConfigEditParamsCaching struct + Disabled param.Field[bool] + MaxAge param.Field[int64] + StaleWhileRevalidate param.Field[int64] + func (r ConfigEditParamsCaching) MarshalJSON() (data []byte, err error) + type ConfigEditParamsCachingHyperdriveHyperdriveCachingCommon struct + Disabled param.Field[bool] + func (r ConfigEditParamsCachingHyperdriveHyperdriveCachingCommon) MarshalJSON() (data []byte, err error) + type ConfigEditParamsCachingHyperdriveHyperdriveCachingEnabled struct + Disabled param.Field[bool] + MaxAge param.Field[int64] + StaleWhileRevalidate param.Field[int64] + func (r ConfigEditParamsCachingHyperdriveHyperdriveCachingEnabled) MarshalJSON() (data []byte, err error) + type ConfigEditParamsCachingUnion interface + type ConfigEditParamsMTLS struct + CACertificateID param.Field[string] + MTLSCertificateID param.Field[string] + Sslmode param.Field[string] + func (r ConfigEditParamsMTLS) MarshalJSON() (data []byte, err error) + type ConfigEditParamsOrigin struct + AccessClientID param.Field[string] + AccessClientSecret param.Field[string] + Database param.Field[string] + Host param.Field[string] + Password param.Field[string] + Port param.Field[int64] + Scheme param.Field[ConfigEditParamsOriginScheme] + ServiceID param.Field[string] + User param.Field[string] + func (r ConfigEditParamsOrigin) MarshalJSON() (data []byte, err error) + type ConfigEditParamsOriginHyperdriveHyperdriveDatabase struct + Database param.Field[string] + Password param.Field[string] + Scheme param.Field[ConfigEditParamsOriginHyperdriveHyperdriveDatabaseScheme] + User param.Field[string] + func (r ConfigEditParamsOriginHyperdriveHyperdriveDatabase) MarshalJSON() (data []byte, err error) + type ConfigEditParamsOriginHyperdriveHyperdriveDatabaseScheme string + const ConfigEditParamsOriginHyperdriveHyperdriveDatabaseSchemeMysql + const ConfigEditParamsOriginHyperdriveHyperdriveDatabaseSchemePostgres + const ConfigEditParamsOriginHyperdriveHyperdriveDatabaseSchemePostgresql + func (r ConfigEditParamsOriginHyperdriveHyperdriveDatabaseScheme) IsKnown() bool + type ConfigEditParamsOriginHyperdriveInternetOrigin struct + Host param.Field[string] + Port param.Field[int64] + func (r ConfigEditParamsOriginHyperdriveInternetOrigin) MarshalJSON() (data []byte, err error) + type ConfigEditParamsOriginHyperdriveOverAccessOrigin struct + AccessClientID param.Field[string] + AccessClientSecret param.Field[string] + Host param.Field[string] + func (r ConfigEditParamsOriginHyperdriveOverAccessOrigin) MarshalJSON() (data []byte, err error) + type ConfigEditParamsOriginHyperdriveVPCServiceOrigin struct + ServiceID param.Field[string] + func (r ConfigEditParamsOriginHyperdriveVPCServiceOrigin) MarshalJSON() (data []byte, err error) + type ConfigEditParamsOriginScheme string + const ConfigEditParamsOriginSchemeMysql + const ConfigEditParamsOriginSchemePostgres + const ConfigEditParamsOriginSchemePostgresql + func (r ConfigEditParamsOriginScheme) IsKnown() bool + type ConfigEditParamsOriginUnion interface + type ConfigEditResponseEnvelope struct + Errors []shared.ResponseInfo + JSON configEditResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result Hyperdrive + Success ConfigEditResponseEnvelopeSuccess + func (r *ConfigEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type ConfigEditResponseEnvelopeSuccess bool + const ConfigEditResponseEnvelopeSuccessTrue + func (r ConfigEditResponseEnvelopeSuccess) IsKnown() bool + type ConfigGetParams struct + AccountID param.Field[string] + type ConfigGetResponseEnvelope struct + Errors []shared.ResponseInfo + JSON configGetResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result Hyperdrive + Success ConfigGetResponseEnvelopeSuccess + func (r *ConfigGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type ConfigGetResponseEnvelopeSuccess bool + const ConfigGetResponseEnvelopeSuccessTrue + func (r ConfigGetResponseEnvelopeSuccess) IsKnown() bool + type ConfigListParams struct + AccountID param.Field[string] + type ConfigNewParams struct + AccountID param.Field[string] + Hyperdrive HyperdriveParam + func (r ConfigNewParams) MarshalJSON() (data []byte, err error) + type ConfigNewResponseEnvelope struct + Errors []shared.ResponseInfo + JSON configNewResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result Hyperdrive + Success ConfigNewResponseEnvelopeSuccess + func (r *ConfigNewResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type ConfigNewResponseEnvelopeSuccess bool + const ConfigNewResponseEnvelopeSuccessTrue + func (r ConfigNewResponseEnvelopeSuccess) IsKnown() bool + type ConfigService struct + Options []option.RequestOption + func NewConfigService(opts ...option.RequestOption) (r *ConfigService) + func (r *ConfigService) Delete(ctx context.Context, hyperdriveID string, body ConfigDeleteParams, ...) (res *ConfigDeleteResponse, err error) + func (r *ConfigService) Edit(ctx context.Context, hyperdriveID string, params ConfigEditParams, ...) (res *Hyperdrive, err error) + func (r *ConfigService) Get(ctx context.Context, hyperdriveID string, query ConfigGetParams, ...) (res *Hyperdrive, err error) + func (r *ConfigService) List(ctx context.Context, query ConfigListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Hyperdrive], err error) + func (r *ConfigService) ListAutoPaging(ctx context.Context, query ConfigListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Hyperdrive] + func (r *ConfigService) New(ctx context.Context, params ConfigNewParams, opts ...option.RequestOption) (res *Hyperdrive, err error) + func (r *ConfigService) Update(ctx context.Context, hyperdriveID string, params ConfigUpdateParams, ...) (res *Hyperdrive, err error) + type ConfigUpdateParams struct + AccountID param.Field[string] + Hyperdrive HyperdriveParam + func (r ConfigUpdateParams) MarshalJSON() (data []byte, err error) + type ConfigUpdateResponseEnvelope struct + Errors []shared.ResponseInfo + JSON configUpdateResponseEnvelopeJSON + Messages []shared.ResponseInfo + Result Hyperdrive + Success ConfigUpdateResponseEnvelopeSuccess + func (r *ConfigUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error) + type ConfigUpdateResponseEnvelopeSuccess bool + const ConfigUpdateResponseEnvelopeSuccessTrue + func (r ConfigUpdateResponseEnvelopeSuccess) IsKnown() bool + type Error = apierror.Error + type ErrorData = shared.ErrorData + type ErrorDataSource = shared.ErrorDataSource + type Hyperdrive struct + Caching HyperdriveCaching + CreatedOn time.Time + ID string + JSON hyperdriveJSON + MTLS HyperdriveMTLS + ModifiedOn time.Time + Name string + Origin HyperdriveOrigin + OriginConnectionLimit int64 + func (r *Hyperdrive) UnmarshalJSON(data []byte) (err error) + type HyperdriveCaching struct + Disabled bool + JSON hyperdriveCachingJSON + MaxAge int64 + StaleWhileRevalidate int64 + func (r *HyperdriveCaching) UnmarshalJSON(data []byte) (err error) + func (r HyperdriveCaching) AsUnion() HyperdriveCachingUnion + type HyperdriveCachingHyperdriveHyperdriveCachingCommon struct + Disabled bool + JSON hyperdriveCachingHyperdriveHyperdriveCachingCommonJSON + func (r *HyperdriveCachingHyperdriveHyperdriveCachingCommon) UnmarshalJSON(data []byte) (err error) + type HyperdriveCachingHyperdriveHyperdriveCachingCommonParam struct + Disabled param.Field[bool] + func (r HyperdriveCachingHyperdriveHyperdriveCachingCommonParam) MarshalJSON() (data []byte, err error) + type HyperdriveCachingHyperdriveHyperdriveCachingEnabled struct + Disabled bool + JSON hyperdriveCachingHyperdriveHyperdriveCachingEnabledJSON + MaxAge int64 + StaleWhileRevalidate int64 + func (r *HyperdriveCachingHyperdriveHyperdriveCachingEnabled) UnmarshalJSON(data []byte) (err error) + type HyperdriveCachingHyperdriveHyperdriveCachingEnabledParam struct + Disabled param.Field[bool] + MaxAge param.Field[int64] + StaleWhileRevalidate param.Field[int64] + func (r HyperdriveCachingHyperdriveHyperdriveCachingEnabledParam) MarshalJSON() (data []byte, err error) + type HyperdriveCachingParam struct + Disabled param.Field[bool] + MaxAge param.Field[int64] + StaleWhileRevalidate param.Field[int64] + func (r HyperdriveCachingParam) MarshalJSON() (data []byte, err error) + type HyperdriveCachingUnion interface + type HyperdriveCachingUnionParam interface + type HyperdriveMTLS struct + CACertificateID string + JSON hyperdriveMTLSJSON + MTLSCertificateID string + Sslmode string + func (r *HyperdriveMTLS) UnmarshalJSON(data []byte) (err error) + type HyperdriveMTLSParam struct + CACertificateID param.Field[string] + MTLSCertificateID param.Field[string] + Sslmode param.Field[string] + func (r HyperdriveMTLSParam) MarshalJSON() (data []byte, err error) + type HyperdriveOrigin struct + AccessClientID string + Database string + Host string + JSON hyperdriveOriginJSON + Port int64 + Scheme HyperdriveOriginScheme + ServiceID string + User string + func (r *HyperdriveOrigin) UnmarshalJSON(data []byte) (err error) + func (r HyperdriveOrigin) AsUnion() HyperdriveOriginUnion + type HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnel struct + AccessClientID string + Database string + Host string + JSON hyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelJSON + Scheme HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme + User string + func (r *HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnel) UnmarshalJSON(data []byte) (err error) + type HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelParam struct + AccessClientID param.Field[string] + AccessClientSecret param.Field[string] + Database param.Field[string] + Host param.Field[string] + Password param.Field[string] + Scheme param.Field[HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme] + User param.Field[string] + func (r HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelParam) MarshalJSON() (data []byte, err error) + type HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme string + const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemeMysql + const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgres + const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgresql + func (r HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme) IsKnown() bool + type HyperdriveOriginDatabaseReachableThroughAWorkersVPC struct + Database string + JSON hyperdriveOriginDatabaseReachableThroughAWorkersVPCJSON + Scheme HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme + ServiceID string + User string + func (r *HyperdriveOriginDatabaseReachableThroughAWorkersVPC) UnmarshalJSON(data []byte) (err error) + type HyperdriveOriginDatabaseReachableThroughAWorkersVPCParam struct + Database param.Field[string] + Password param.Field[string] + Scheme param.Field[HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme] + ServiceID param.Field[string] + User param.Field[string] + func (r HyperdriveOriginDatabaseReachableThroughAWorkersVPCParam) MarshalJSON() (data []byte, err error) + type HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme string + const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemeMysql + const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemePostgres + const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemePostgresql + func (r HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme) IsKnown() bool + type HyperdriveOriginParam struct + AccessClientID param.Field[string] + AccessClientSecret param.Field[string] + Database param.Field[string] + Host param.Field[string] + Password param.Field[string] + Port param.Field[int64] + Scheme param.Field[HyperdriveOriginScheme] + ServiceID param.Field[string] + User param.Field[string] + func (r HyperdriveOriginParam) MarshalJSON() (data []byte, err error) + type HyperdriveOriginPublicDatabase struct + Database string + Host string + JSON hyperdriveOriginPublicDatabaseJSON + Port int64 + Scheme HyperdriveOriginPublicDatabaseScheme + User string + func (r *HyperdriveOriginPublicDatabase) UnmarshalJSON(data []byte) (err error) + type HyperdriveOriginPublicDatabaseParam struct + Database param.Field[string] + Host param.Field[string] + Password param.Field[string] + Port param.Field[int64] + Scheme param.Field[HyperdriveOriginPublicDatabaseScheme] + User param.Field[string] + func (r HyperdriveOriginPublicDatabaseParam) MarshalJSON() (data []byte, err error) + type HyperdriveOriginPublicDatabaseScheme string + const HyperdriveOriginPublicDatabaseSchemeMysql + const HyperdriveOriginPublicDatabaseSchemePostgres + const HyperdriveOriginPublicDatabaseSchemePostgresql + func (r HyperdriveOriginPublicDatabaseScheme) IsKnown() bool + type HyperdriveOriginScheme string + const HyperdriveOriginSchemeMysql + const HyperdriveOriginSchemePostgres + const HyperdriveOriginSchemePostgresql + func (r HyperdriveOriginScheme) IsKnown() bool + type HyperdriveOriginUnion interface + type HyperdriveOriginUnionParam interface + type HyperdriveParam struct + Caching param.Field[HyperdriveCachingUnionParam] + MTLS param.Field[HyperdriveMTLSParam] + Name param.Field[string] + Origin param.Field[HyperdriveOriginUnionParam] + OriginConnectionLimit param.Field[int64] + func (r HyperdriveParam) MarshalJSON() (data []byte, err error) + type HyperdriveService struct + Configs *ConfigService + Options []option.RequestOption + func NewHyperdriveService(opts ...option.RequestOption) (r *HyperdriveService) + type Member = shared.Member + type MemberPoliciesAccess = shared.MemberPoliciesAccess + type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup + type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta + type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup + type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta + type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope + type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject + type MemberPolicy = shared.MemberPolicy + type MemberStatus = shared.MemberStatus + type MemberUser = shared.MemberUser + type Permission = shared.Permission + type PermissionGrant = shared.PermissionGrant + type PermissionGrantParam = shared.PermissionGrantParam + type RatePlan = shared.RatePlan + type RatePlanID = shared.RatePlanID + type RatePlanParam = shared.RatePlanParam + type ResponseInfo = shared.ResponseInfo + type ResponseInfoSource = shared.ResponseInfoSource + type Role = shared.Role + type RoleParam = shared.RoleParam + type RolePermissions = shared.RolePermissions + type RolePermissionsParam = shared.RolePermissionsParam + type SortDirection = shared.SortDirection + type Subscription = shared.Subscription + type SubscriptionFrequency = shared.SubscriptionFrequency + type SubscriptionParam = shared.SubscriptionParam + type SubscriptionState = shared.SubscriptionState + type Token = shared.Token + type TokenCondition = shared.TokenCondition + type TokenConditionCIDRList = shared.TokenConditionCIDRList + type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam + type TokenConditionParam = shared.TokenConditionParam + type TokenConditionRequestIP = shared.TokenConditionRequestIP + type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam + type TokenParam = shared.TokenParam + type TokenPolicy = shared.TokenPolicy + type TokenPolicyEffect = shared.TokenPolicyEffect + type TokenPolicyParam = shared.TokenPolicyParam + type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup + type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam + type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta + type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam + type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested + type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam + type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString + type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam + type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion + type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam + type TokenStatus = shared.TokenStatus + type TokenValue = shared.TokenValue Other modules containing this package github.com/cloudflare/cloudflare-go/v2 github.com/cloudflare/cloudflare-go/v3 github.com/cloudflare/cloudflare-go/v4 github.com/cloudflare/cloudflare-go/v5 github.com/cloudflare/cloudflare-go/v6
Go to main page