const (// AuthKeyEmail specifies that we should authenticate with API key and email address.AuthKeyEmail = 1 <<iota// AuthUserService specifies that we should authenticate with a User-Service key.AuthUserService// AuthToken specifies that we should authenticate with an API Token.AuthToken)

const (IPAccessRulesConfigurationTargetListIPAccessRulesOrderOption = "configuration.target"IPAccessRulesConfigurationValueListIPAccessRulesOrderOption = "configuration.value"IPAccessRulesMatchOptionAllListIPAccessRulesMatchOption = "all"IPAccessRulesMatchOptionAnyListIPAccessRulesMatchOption = "any"IPAccessRulesModeBlockIPAccessRulesModeOption      = "block"IPAccessRulesModeChallengeIPAccessRulesModeOption      = "challenge"IPAccessRulesModeJsChallengeIPAccessRulesModeOption      = "js_challenge"IPAccessRulesModeManagedChallengeIPAccessRulesModeOption      = "managed_challenge"IPAccessRulesModeWhitelistIPAccessRulesModeOption      = "whitelist")

const (// ListTypeIP specifies a list containing IP addresses.ListTypeIP = "ip"// ListTypeRedirect specifies a list containing redirects.ListTypeRedirect = "redirect"// ListTypeHostname specifies a list containing hostnames.ListTypeHostname = "hostname"// ListTypeHostname specifies a list containing autonomous system numbers (ASNs).ListTypeASN = "asn")

const (// MagicFirewallRulesetKindRoot specifies a root Ruleset.MagicFirewallRulesetKindRoot = "root"// MagicFirewallRulesetPhaseMagicTransit specifies the Magic Transit Ruleset phase.MagicFirewallRulesetPhaseMagicTransit = "magic_transit"// MagicFirewallRulesetRuleActionSkip specifies a skip (allow) action.MagicFirewallRulesetRuleActionSkipMagicFirewallRulesetRuleAction = "skip"// MagicFirewallRulesetRuleActionBlock specifies a block action.MagicFirewallRulesetRuleActionBlockMagicFirewallRulesetRuleAction = "block")

const (AccountRouteLevelRouteLevel = accountsZoneRouteLevelRouteLevel = zonesUserRouteLevelRouteLevel = userAccountTypeResourceType = accountZoneTypeResourceType = zoneUserTypeResourceType = user)

const (RulesetKindCustomRulesetKind = "custom"RulesetKindManagedRulesetKind = "managed"RulesetKindRootRulesetKind = "root"RulesetKindZoneRulesetKind = "zone"RulesetPhaseDDoSL4RulesetPhase = "ddos_l4"RulesetPhaseDDoSL7RulesetPhase = "ddos_l7"RulesetPhaseHTTPConfigSettingsRulesetPhase = "http_config_settings"RulesetPhaseHTTPCustomErrorsRulesetPhase = "http_custom_errors"RulesetPhaseHTTPLogCustomFieldsRulesetPhase = "http_log_custom_fields"RulesetPhaseHTTPRatelimitRulesetPhase = "http_ratelimit"RulesetPhaseHTTPRequestCacheSettingsRulesetPhase = "http_request_cache_settings"RulesetPhaseHTTPRequestDynamicRedirectRulesetPhase = "http_request_dynamic_redirect"//nolint:gosecRulesetPhaseHTTPRequestFirewallCustomRulesetPhase = "http_request_firewall_custom"RulesetPhaseHTTPRequestFirewallManagedRulesetPhase = "http_request_firewall_managed"RulesetPhaseHTTPRequestLateTransformRulesetPhase = "http_request_late_transform"RulesetPhaseHTTPRequestOriginRulesetPhase = "http_request_origin"RulesetPhaseHTTPRequestRedirectRulesetPhase = "http_request_redirect"RulesetPhaseHTTPRequestSanitizeRulesetPhase = "http_request_sanitize"RulesetPhaseHTTPRequestTransformRulesetPhase = "http_request_transform"RulesetPhaseHTTPResponseCompressionRulesetPhase = "http_response_compression"RulesetPhaseHTTPResponseFirewallManagedRulesetPhase = "http_response_firewall_managed"RulesetPhaseHTTPResponseHeadersTransformRulesetPhase = "http_response_headers_transform"RulesetPhaseMagicTransitRulesetPhase = "magic_transit"RulesetRuleActionBlockRulesetRuleAction = "block"RulesetRuleActionChallengeRulesetRuleAction = "challenge"RulesetRuleActionCompressResponseRulesetRuleAction = "compress_response"RulesetRuleActionDDoSDynamicRulesetRuleAction = "ddos_dynamic"RulesetRuleActionDDoSMitigationRulesetRuleAction = "ddos_mitigation"RulesetRuleActionExecuteRulesetRuleAction = "execute"RulesetRuleActionForceConnectionCloseRulesetRuleAction = "force_connection_close"RulesetRuleActionJSChallengeRulesetRuleAction = "js_challenge"RulesetRuleActionLogRulesetRuleAction = "log"RulesetRuleActionLogCustomFieldRulesetRuleAction = "log_custom_field"RulesetRuleActionManagedChallengeRulesetRuleAction = "managed_challenge"RulesetRuleActionRedirectRulesetRuleAction = "redirect"RulesetRuleActionRewriteRulesetRuleAction = "rewrite"RulesetRuleActionRouteRulesetRuleAction = "route"RulesetRuleActionScoreRulesetRuleAction = "score"RulesetRuleActionServeErrorRulesetRuleAction = "serve_error"RulesetRuleActionSetCacheSettingsRulesetRuleAction = "set_cache_settings"RulesetRuleActionSetConfigRulesetRuleAction = "set_config"RulesetRuleActionSkipRulesetRuleAction = "skip"RulesetActionParameterProductBICRulesetActionParameterProduct = "bic"RulesetActionParameterProductHOTRulesetActionParameterProduct = "hot"RulesetActionParameterProductRateLimitRulesetActionParameterProduct = "ratelimit"RulesetActionParameterProductSecurityLevelRulesetActionParameterProduct = "securityLevel"RulesetActionParameterProductUABlockRulesetActionParameterProduct = "uablock"RulesetActionParameterProductWAFRulesetActionParameterProduct = "waf"RulesetActionParameterProductZoneLockdownRulesetActionParameterProduct = "zonelockdown"RulesetRuleActionParametersHTTPHeaderOperationRemoveRulesetRuleActionParametersHTTPHeaderOperation = "remove"RulesetRuleActionParametersHTTPHeaderOperationSetRulesetRuleActionParametersHTTPHeaderOperation = "set"RulesetRuleActionParametersHTTPHeaderOperationAddRulesetRuleActionParametersHTTPHeaderOperation = "add")

const DEFAULT_VALIDITY_PERIOD_DAYS = 1826

const (// IPListTypeIP specifies a list containing IP addresses.IPListTypeIP = "ip")

var (ErrAPIKeysAndTokensAreMutuallyExclusive   =errors.New(errAPIKeysAndTokensAreMutuallyExclusive)ErrMissingCredentials                     =errors.New(errMissingCredentials)ErrMissingAccountID                       =errors.New(errMissingAccountID)ErrMissingZoneID                          =errors.New(errMissingZoneID)ErrAccountIDOrZoneIDAreRequired           =errors.New(errMissingAccountOrZoneID)ErrAccountIDAndZoneIDAreMutuallyExclusive =errors.New(errAccountIDAndZoneIDAreMutuallyExclusive)ErrMissingResourceIdentifier              =errors.New(errMissingResourceIdentifier)ErrRequiredAccountLevelResourceContainer =errors.New(errRequiredAccountLevelResourceContainer)ErrRequiredZoneLevelResourceContainer    =errors.New(errRequiredZoneLevelResourceContainer)ErrMissingDetectionID                    =errors.New(errMissingDetectionID))

var (ErrMissingHyperdriveConfigID             =errors.New("required hyperdrive config id is missing")ErrMissingHyperdriveConfigName           =errors.New("required hyperdrive config name is missing")ErrMissingHyperdriveConfigOriginDatabase =errors.New("required hyperdrive config origin database is missing")ErrMissingHyperdriveConfigOriginPassword =errors.New("required hyperdrive config origin password is missing")ErrMissingHyperdriveConfigOriginHost     =errors.New("required hyperdrive config origin host is missing")ErrMissingHyperdriveConfigOriginScheme   =errors.New("required hyperdrive config origin scheme is missing")ErrMissingHyperdriveConfigOriginUser     =errors.New("required hyperdrive config origin user is missing"))

var (ErrInvalidImagesAPIVersion =errors.New("invalid images API version")ErrMissingImageID          =errors.New("required image ID missing"))

var (ErrMissingPoolID         =errors.New("missing required pool ID")ErrMissingMonitorID      =errors.New("missing required monitor ID")ErrMissingLoadBalancerID =errors.New("missing required load balancer ID"))

var (// ErrMissingIP is for when ipv4 or ipv6 indicator was given but ip is missing.ErrMissingIP =errors.New("ip is required when using 'ipv4' or 'ipv6' indicator type and is missing")// ErrMissingURL is for when url or domain indicator was given but url is missing.ErrMissingURL =errors.New("url is required when using 'domain' or 'url' indicator type and is missing"))

var (ErrMissingObservatoryUrl    =errors.New("missing required page url")ErrMissingObservatoryTestID =errors.New("missing required test id"))

var (ErrMissingProjectName  =errors.New("required missing project name")ErrMissingDeploymentID =errors.New("required missing deployment ID"))

var (ErrMissingQueueName         =errors.New("required queue name is missing")ErrMissingQueueConsumerName =errors.New("required queue consumer name is missing"))

var (// ErrMissingUploadURL is for when a URL is required but missing.ErrMissingUploadURL =errors.New("required url missing")// ErrMissingMaxDuration is for when MaxDuration is required but missing.ErrMissingMaxDuration =errors.New("required max duration missing")// ErrMissingVideoID is for when VideoID is required but missing.ErrMissingVideoID =errors.New("required video id missing")// ErrMissingFilePath is for when FilePath is required but missing.ErrMissingFilePath =errors.New("required file path missing")// ErrMissingTusResumable is for when TusResumable is required but missing.ErrMissingTusResumable =errors.New("required tus resumable missing")// ErrInvalidTusResumable is for when TusResumable is invalid.ErrInvalidTusResumable =errors.New("invalid tus resumable")// ErrMarshallingTUSMetadata is for when TUS metadata cannot be marshalled.ErrMarshallingTUSMetadata =errors.New("error marshalling TUS metadata")// ErrMissingUploadLength is for when UploadLength is required but missing.ErrMissingUploadLength =errors.New("required upload length missing")// ErrInvalidStatusCode is for when the status code is invalid.ErrInvalidStatusCode =errors.New("invalid status code"))

var (ErrMissingNetwork      =errors.New("missing required network parameter")ErrInvalidNetworkValue =errors.New("invalid IP parameter. Cannot use CIDR ranges for this endpoint."))

var (ErrMissingWaitingRoomID     =errors.New("missing required waiting room ID")ErrMissingWaitingRoomRuleID =errors.New("missing required waiting room rule ID"))

var (// ErrMissingIdentifier is for when identifier is required but missing.ErrMissingIdentifier =errors.New("identifier required but missing")// ErrMissingName is for when name is required but missing.ErrMissingName =errors.New("name required but missing")// ErrMissingTarget is for when target is required but missing.ErrMissingTarget =errors.New("target required but missing"))

var (ErrMissingWebAnalyticsSiteTag     =errors.New("missing required web analytics site ID")ErrMissingWebAnalyticsRulesetID   =errors.New("missing required web analytics ruleset ID")ErrMissingWebAnalyticsRuleID      =errors.New("missing required web analytics rule ID")ErrMissingWebAnalyticsSiteHost    =errors.New("missing required web analytics host or zone_tag")ErrConflictingWebAnalyticSiteHost =errors.New("conflicting web analytics host and zone_tag, only one must be specified"))

var (ErrMissingHostname    =errors.New("required hostname missing")ErrMissingService     =errors.New("required service missing")ErrMissingEnvironment =errors.New("required environment missing"))

var (ErrMissingScriptName =errors.New("required script name missing")ErrMissingTailID     =errors.New("required tail id missing"))

var ErrMissingASN =errors.New("required asn missing")

var ErrMissingBINDContents =errors.New("required BIND config contents missing")

var (ErrMissingBucketName =errors.New("require bucket name missing"))

var (ErrMissingCertificateID =errors.New("missing required certificate ID"))

var ErrMissingClusterID =errors.New("missing required cluster ID")

var ErrMissingDNSRecordID =errors.New("required DNS record ID missing")

var (ErrMissingDatabaseID =fmt.Errorf("required missing database ID"))

var (ErrMissingDatasetID =errors.New("missing required dataset ID"))

var ErrMissingDomain =errors.New("required domain missing")

var (ErrMissingHostnameTLSSettingName =errors.New("tls setting name required but missing"))

var ErrMissingListID =errors.New("required missing list ID")

var ErrMissingMemberRolesOrPolicies =errors.New(errMissingMemberRolesOrPolicies)

var ErrMissingPermissionGroupID =errors.New(errMissingPermissionGroupID)

var (ErrMissingProfileID =errors.New("missing required profile ID"))

var (ErrMissingRiskScoreIntegrationID =errors.New("missing required Risk Score Integration UUID"))

var ErrMissingRuleID =errors.New("required rule id missing")

var (ErrMissingRulesetPhase =errors.New("missing required phase"))

var (ErrMissingServiceTokenUUID =errors.New("missing required service token UUID"))

var (// ErrMissingSettingName is for when setting name is required but missing.ErrMissingSettingName =errors.New("zone setting name required but missing"))

var ErrMissingSiteKey =errors.New("required site key missing")

var ErrMissingTargetId =errors.New("required target id missing")

var ErrMissingTunnelID =errors.New("required missing tunnel ID")

var ErrMissingUID =errors.New("required UID missing")

var ErrMissingVnetName =errors.New("required missing virtual network name")

var ErrMissingWorkerRouteID =errors.New("missing required route ID")

var ErrNotEnoughFilterIDsProvided =errors.New("at least one filter ID must be provided.")

var ErrOriginPortInvalid =errors.New("invalid origin port")

var PageRuleActions = map[string]string{"always_online":               "Always Online","always_use_https":            "Always Use HTTPS","automatic_https_rewrites":    "Automatic HTTPS Rewrites","browser_cache_ttl":           "Browser Cache TTL","browser_check":               "Browser Integrity Check","bypass_cache_on_cookie":      "Bypass Cache on Cookie","cache_by_device_type":        "Cache By Device Type","cache_deception_armor":       "Cache Deception Armor","cache_level":                 "Cache Level","cache_key_fields":            "Custom Cache Key","cache_on_cookie":             "Cache On Cookie","disable_apps":                "Disable Apps","disable_performance":         "Disable Performance","disable_railgun":             "Disable Railgun","disable_security":            "Disable Security","edge_cache_ttl":              "Edge Cache TTL","email_obfuscation":           "Email Obfuscation","explicit_cache_control":      "Origin Cache Control","forwarding_url":              "Forwarding URL","host_header_override":        "Host Header Override","ip_geolocation":              "IP Geolocation Header","minify":                      "Minify","mirage":                      "Mirage","opportunistic_encryption":    "Opportunistic Encryption","origin_error_page_pass_thru": "Origin Error Page Pass-thru","polish":                      "Polish","resolve_override":            "Resolve Override","respect_strong_etag":         "Respect Strong ETags","response_buffering":          "Response Buffering","rocket_loader":               "Rocker Loader","security_level":              "Security Level","server_side_exclude":         "Server Side Excludes","sort_query_string_for_cache": "Query String Sort","ssl":                         "SSL","true_client_ip_header":       "True Client IP Header","waf":                         "Web Application Firewall",}

var (Versionstring = "v4")

funcAnyPtr¶added inv0.35.0

func AnyPtr[Tany](v T) *T

AnyPtr is a helper routine that allocates a new interface valueto store v and returns a pointer to it.

Usage: var _ *Type = AnyPtr(Type(value) | value).(*Type)

var _ *bool = AnyPtr(true).(*bool)var _ *byte = AnyPtr(byte(1)).(*byte)var _ *complex64 = AnyPtr(complex64(1.1)).(*complex64)var _ *complex128 = AnyPtr(complex128(1.1)).(*complex128)var _ *float32 = AnyPtr(float32(1.1)).(*float32)var _ *float64 = AnyPtr(float64(1.1)).(*float64)var _ *int = AnyPtr(int(1)).(*int)var _ *int8 = AnyPtr(int8(8)).(*int8)var _ *int16 = AnyPtr(int16(16)).(*int16)var _ *int32 = AnyPtr(int32(32)).(*int32)var _ *int64 = AnyPtr(int64(64)).(*int64)var _ *rune = AnyPtr(rune(1)).(*rune)var _ *string = AnyPtr("ptr").(*string)var _ *uint = AnyPtr(uint(1)).(*uint)var _ *uint8 = AnyPtr(uint8(8)).(*uint8)var _ *uint16 = AnyPtr(uint16(16)).(*uint16)var _ *uint32 = AnyPtr(uint32(32)).(*uint32)var _ *uint64 = AnyPtr(uint64(64)).(*uint64)

funcBool¶

func Bool(v *bool)bool

Bool is a helper routine that accepts a bool pointer and returns a valueto it.

funcBoolMap¶added inv0.36.0

func BoolMap(src map[string]*bool) map[string]bool

BoolMap converts a string map of bool pointers into a string map of boolvalues.

funcBoolPtr¶added inv0.35.0

func BoolPtr(vbool) *bool

BoolPtr is a helper routine that allocates a new bool value to store v andreturns a pointer to it.

funcBoolPtrMap¶added inv0.35.0

func BoolPtrMap(src map[string]bool) map[string]*bool

BoolPtrMap converts a string map of bool values into a string map of boolpointers.

funcBoolPtrSlice¶added inv0.35.0

func BoolPtrSlice(src []bool) []*bool

BoolPtrSlice converts a slice of bool values into a slice of bool pointers.

funcBoolSlice¶added inv0.36.0

func BoolSlice(src []*bool) []bool

BoolSlice converts a slice of bool pointers into a slice of bool values.

funcByte¶added inv0.36.0

func Byte(v *byte)byte

Byte is a helper routine that accepts a byte pointer and returns avalue to it.

funcBytePtr¶added inv0.35.0

func BytePtr(vbyte) *byte

BytePtr is a helper routine that allocates a new byte value to store v andreturns a pointer to it.

funcComplex128¶added inv0.36.0

func Complex128(v *complex128)complex128

Complex128 is a helper routine that accepts a complex128 pointer andreturns a value to it.

funcComplex128Ptr¶added inv0.35.0

func Complex128Ptr(vcomplex128) *complex128

Complex128Ptr is a helper routine that allocates a new complex128 valueto store v and returns a pointer to it.

funcComplex64¶added inv0.36.0

func Complex64(v *complex64)complex64

Complex64 is a helper routine that accepts a complex64 pointer andreturns a value to it.

funcComplex64Ptr¶added inv0.35.0

func Complex64Ptr(vcomplex64) *complex64

Complex64Ptr is a helper routine that allocates a new complex64 value tostore v and returns a pointer to it.

funcDurationPtr¶added inv0.35.0

func DurationPtr(vtime.Duration) *time.Duration

DurationPtr is a helper routine that allocates a new time.Duration valueto store v and returns a pointer to it.

funcFloat32¶added inv0.36.0

func Float32(v *float32)float32

Float32 is a helper routine that accepts a float32 pointer and returns avalue to it.

funcFloat32Map¶added inv0.36.0

func Float32Map(src map[string]*float32) map[string]float32

Float32Map converts a string map of float32 pointers into a stringmap of float32 values.

funcFloat32Ptr¶added inv0.35.0

func Float32Ptr(vfloat32) *float32

Float32Ptr is a helper routine that allocates a new float32 value to store vand returns a pointer to it.

funcFloat32PtrMap¶added inv0.35.0

func Float32PtrMap(src map[string]float32) map[string]*float32

Float32PtrMap converts a string map of float32 values into a string map offloat32 pointers.

funcFloat32PtrSlice¶added inv0.35.0

func Float32PtrSlice(src []float32) []*float32

Float32PtrSlice converts a slice of float32 values into a slice of float32pointers.

funcFloat32Slice¶added inv0.36.0

func Float32Slice(src []*float32) []float32

Float32Slice converts a slice of float32 pointers into a slice offloat32 values.

funcFloat64¶added inv0.36.0

func Float64(v *float64)float64

Float64 is a helper routine that accepts a float64 pointer and returns avalue to it.

funcFloat64Map¶added inv0.36.0

func Float64Map(src map[string]*float64) map[string]float64

Float64Map converts a string map of float64 pointers into a stringmap of float64 values.

funcFloat64Ptr¶added inv0.35.0

func Float64Ptr(vfloat64) *float64

Float64Ptr is a helper routine that allocates a new float64 value to store vand returns a pointer to it.

funcFloat64PtrMap¶added inv0.35.0

func Float64PtrMap(src map[string]float64) map[string]*float64

Float64PtrMap converts a string map of float64 values into a string map offloat64 pointers.

funcFloat64PtrSlice¶added inv0.35.0

func Float64PtrSlice(src []float64) []*float64

Float64PtrSlice converts a slice of float64 values into a slice of float64pointers.

funcFloat64Slice¶added inv0.36.0

func Float64Slice(src []*float64) []float64

Float64Slice converts a slice of float64 pointers into a slice offloat64 values.

funcGetOriginCARootCertificate¶added inv0.58.0

func GetOriginCARootCertificate(algorithmstring) ([]byte,error)

Gets the Cloudflare Origin CA Root Certificate for a given algorithm in PEM format.Algorithm must be one of ['ecc', 'rsa'].

funcInt¶

func Int(v *int)int

Int is a helper routine that accepts a int pointer and returns a valueto it.

funcInt16¶added inv0.36.0

func Int16(v *int16)int16

Int16 is a helper routine that accepts a int16 pointer and returns avalue to it.

funcInt16Map¶added inv0.36.0

func Int16Map(src map[string]*int16) map[string]int16

Int16Map converts a string map of int16 pointers into a string map ofint16 values.

funcInt16Ptr¶added inv0.35.0

func Int16Ptr(vint16) *int16

Int16Ptr is a helper routine that allocates a new int16 value to store vand returns a pointer to it.

funcInt16PtrMap¶added inv0.35.0

func Int16PtrMap(src map[string]int16) map[string]*int16

Int16PtrMap converts a string map of int16 values into a string map of int16pointers.

funcInt16PtrSlice¶added inv0.35.0

func Int16PtrSlice(src []int16) []*int16

Int16PtrSlice converts a slice of int16 values into a slice of int16pointers.

funcInt16Slice¶added inv0.36.0

func Int16Slice(src []*int16) []int16

Int16Slice converts a slice of int16 pointers into a slice of int16values.

funcInt32¶added inv0.36.0

func Int32(v *int32)int32

Int32 is a helper routine that accepts a int32 pointer and returns avalue to it.

funcInt32Map¶added inv0.36.0

func Int32Map(src map[string]*int32) map[string]int32

Int32Map converts a string map of int32 pointers into a string map ofint32 values.

funcInt32Ptr¶added inv0.35.0

func Int32Ptr(vint32) *int32

Int32Ptr is a helper routine that allocates a new int32 value to store vand returns a pointer to it.

funcInt32PtrMap¶added inv0.35.0

func Int32PtrMap(src map[string]int32) map[string]*int32

Int32PtrMap converts a string map of int32 values into a string map of int32pointers.

funcInt32PtrSlice¶added inv0.35.0

func Int32PtrSlice(src []int32) []*int32

Int32PtrSlice converts a slice of int32 values into a slice of int32pointers.

funcInt32Slice¶added inv0.36.0

func Int32Slice(src []*int32) []int32

Int32Slice converts a slice of int32 pointers into a slice of int32values.

funcInt64¶added inv0.36.0

func Int64(v *int64)int64

Int64 is a helper routine that accepts a int64 pointer and returns avalue to it.

funcInt64Map¶added inv0.36.0

func Int64Map(src map[string]*int64) map[string]int64

Int64Map converts a string map of int64 pointers into a string map ofint64 values.

funcInt64Ptr¶added inv0.35.0

func Int64Ptr(vint64) *int64

Int64Ptr is a helper routine that allocates a new int64 value to store vand returns a pointer to it.

funcInt64PtrMap¶added inv0.35.0

func Int64PtrMap(src map[string]int64) map[string]*int64

Int64PtrMap converts a string map of int64 values into a string map of int64pointers.

funcInt64PtrSlice¶added inv0.35.0

func Int64PtrSlice(src []int64) []*int64

Int64PtrSlice converts a slice of int64 values into a slice of int64pointers.

funcInt64Slice¶added inv0.36.0

func Int64Slice(src []*int64) []int64

Int64Slice converts a slice of int64 pointers into a slice of int64values.

funcInt8¶added inv0.36.0

func Int8(v *int8)int8

Int8 is a helper routine that accepts a int8 pointer and returns a valueto it.

funcInt8Map¶added inv0.36.0

func Int8Map(src map[string]*int8) map[string]int8

Int8Map converts a string map of int8 pointers into a string map of int8values.

funcInt8Ptr¶added inv0.35.0

func Int8Ptr(vint8) *int8

Int8Ptr is a helper routine that allocates a new int8 value to store v andreturns a pointer to it.

funcInt8PtrMap¶added inv0.35.0

func Int8PtrMap(src map[string]int8) map[string]*int8

Int8PtrMap converts a string map of int8 values into a string map of int8pointers.

funcInt8PtrSlice¶added inv0.35.0

func Int8PtrSlice(src []int8) []*int8

Int8PtrSlice converts a slice of int8 values into a slice of int8 pointers.

funcInt8Slice¶added inv0.36.0

func Int8Slice(src []*int8) []int8

Int8Slice converts a slice of int8 pointers into a slice of int8 values.

funcIntMap¶added inv0.36.0

func IntMap(src map[string]*int) map[string]int

IntMap converts a string map of int pointers into a string map of intvalues.

funcIntPtr¶added inv0.35.0

func IntPtr(vint) *int

IntPtr is a helper routine that allocates a new int value to store v andreturns a pointer to it.

funcIntPtrMap¶added inv0.35.0

func IntPtrMap(src map[string]int) map[string]*int

IntPtrMap converts a string map of int values into a string map of intpointers.

funcIntPtrSlice¶added inv0.35.0

func IntPtrSlice(src []int) []*int

IntPtrSlice converts a slice of int values into a slice of int pointers.

funcIntSlice¶added inv0.36.0

func IntSlice(src []*int) []int

IntSlice converts a slice of int pointers into a slice of int values.

funcRulesetActionParameterProductValues¶added inv0.19.0

func RulesetActionParameterProductValues() []string

RulesetActionParameterProductValues exposes all the available`RulesetActionParameterProduct` values as a slice of strings.

funcRulesetKindValues¶added inv0.19.0

func RulesetKindValues() []string

RulesetKindValues exposes all the available `RulesetKind` values as a sliceof strings.

funcRulesetPhaseValues¶added inv0.19.0

func RulesetPhaseValues() []string

RulesetPhaseValues exposes all the available `RulesetPhase` values as a sliceof strings.

funcRulesetRuleActionParametersHTTPHeaderOperationValues¶added inv0.19.0

func RulesetRuleActionParametersHTTPHeaderOperationValues() []string

funcRulesetRuleActionValues¶added inv0.19.0

func RulesetRuleActionValues() []string

RulesetRuleActionValues exposes all the available `RulesetRuleAction` valuesas a slice of strings.

funcRune¶added inv0.36.0

func Rune(v *rune)rune

Rune is a helper routine that accepts a rune pointer and returns a valueto it.

funcRunePtr¶added inv0.35.0

func RunePtr(vrune) *rune

RunePtr is a helper routine that allocates a new rune value to store vand returns a pointer to it.

funcString¶

func String(v *string)string

String is a helper routine that accepts a string pointer and returns avalue to it.

funcStringMap¶added inv0.36.0

func StringMap(src map[string]*string) map[string]string

StringMap converts a string map of string pointers into a string map ofstring values.

funcStringPtr¶added inv0.35.0

func StringPtr(vstring) *string

StringPtr is a helper routine that allocates a new string value to store vand returns a pointer to it.

funcStringPtrMap¶added inv0.35.0

func StringPtrMap(src map[string]string) map[string]*string

StringPtrMap converts a string map of string values into a string map ofstring pointers.

funcStringPtrSlice¶added inv0.35.0

func StringPtrSlice(src []string) []*string

StringPtrSlice converts a slice of string values into a slice of stringpointers.

funcStringSlice¶added inv0.36.0

func StringSlice(src []*string) []string

StringSlice converts a slice of string pointers into a slice of stringvalues.

funcTeamsRulesActionValues¶added inv0.22.0

func TeamsRulesActionValues() []string

funcTeamsRulesUntrustedCertActionValues¶added inv0.62.0

func TeamsRulesUntrustedCertActionValues() []string

funcTime¶added inv0.36.0

func Time(v *time.Time)time.Time

Time is a helper routine that accepts a time pointer value and returns avalue to it.

funcTimePtr¶added inv0.35.0

func TimePtr(vtime.Time) *time.Time

TimePtr is a helper routine that allocates a new time.Time valueto store v and returns a pointer to it.

funcUint¶added inv0.36.0

func Uint(v *uint)uint

Uint is a helper routine that accepts a uint pointer and returns a valueto it.

funcUint16¶added inv0.36.0

func Uint16(v *uint16)uint16

Uint16 is a helper routine that accepts a uint16 pointer and returns avalue to it.

funcUint16Map¶added inv0.36.0

func Uint16Map(src map[string]*uint16) map[string]uint16

Uint16Map converts a string map of uint16 pointers into a string map ofuint16 values.

funcUint16Ptr¶added inv0.35.0

func Uint16Ptr(vuint16) *uint16

Uint16Ptr is a helper routine that allocates a new uint16 value to store vand returns a pointer to it.

funcUint16PtrMap¶added inv0.35.0

func Uint16PtrMap(src map[string]uint16) map[string]*uint16

Uint16PtrMap converts a string map of uint16 values into a string map ofuint16 pointers.

funcUint16PtrSlice¶added inv0.35.0

func Uint16PtrSlice(src []uint16) []*uint16

Uint16PtrSlice converts a slice of uint16 values into a slice of uint16pointers.

funcUint16Slice¶added inv0.36.0

func Uint16Slice(src []*uint16) []uint16

Uint16Slice converts a slice of uint16 pointers into a slice of uint16values.

funcUint32¶added inv0.36.0

func Uint32(v *uint32)uint32

Uint32 is a helper routine that accepts a uint32 pointer and returns avalue to it.

funcUint32Map¶added inv0.36.0

func Uint32Map(src map[string]*uint32) map[string]uint32

Uint32Map converts a string map of uint32 pointers into a stringmap of uint32 values.

funcUint32Ptr¶added inv0.35.0

func Uint32Ptr(vuint32) *uint32

Uint32Ptr is a helper routine that allocates a new uint32 value to store vand returns a pointer to it.

funcUint32PtrMap¶added inv0.35.0

func Uint32PtrMap(src map[string]uint32) map[string]*uint32

Uint32PtrMap converts a string map of uint32 values into a string map ofuint32 pointers.

funcUint32PtrSlice¶added inv0.35.0

func Uint32PtrSlice(src []uint32) []*uint32

Uint32PtrSlice converts a slice of uint32 values into a slice of uint32pointers.

funcUint32Slice¶added inv0.36.0

func Uint32Slice(src []*uint32) []uint32

Uint32Slice converts a slice of uint32 pointers into a slice of uint32values.

funcUint64¶added inv0.36.0

func Uint64(v *uint64)uint64

Uint64 is a helper routine that accepts a uint64 pointer and returns avalue to it.

funcUint64Map¶added inv0.36.0

func Uint64Map(src map[string]*uint64) map[string]uint64

Uint64Map converts a string map of uint64 pointers into a string map ofuint64 values.

funcUint64Ptr¶added inv0.35.0

func Uint64Ptr(vuint64) *uint64

Uint64Ptr is a helper routine that allocates a new uint64 value to store vand returns a pointer to it.

funcUint64PtrMap¶added inv0.35.0

func Uint64PtrMap(src map[string]uint64) map[string]*uint64

Uint64PtrMap converts a string map of uint64 values into a string map ofuint64 pointers.

funcUint64PtrSlice¶added inv0.35.0

func Uint64PtrSlice(src []uint64) []*uint64

Uint64PtrSlice converts a slice of uint64 values into a slice of uint64pointers.

funcUint64Slice¶added inv0.36.0

func Uint64Slice(src []*uint64) []uint64

Uint64Slice converts a slice of uint64 pointers into a slice of uint64values.

funcUint8¶added inv0.36.0

func Uint8(v *uint8)uint8

Uint8 is a helper routine that accepts a uint8 pointer and returns avalue to it.

funcUint8Map¶added inv0.36.0

func Uint8Map(src map[string]*uint8) map[string]uint8

Uint8Map converts a string map of uint8 pointers into a stringmap of uint8 values.

funcUint8Ptr¶added inv0.35.0

func Uint8Ptr(vuint8) *uint8

Uint8Ptr is a helper routine that allocates a new uint8 value to store vand returns a pointer to it.

funcUint8PtrMap¶added inv0.35.0

func Uint8PtrMap(src map[string]uint8) map[string]*uint8

Uint8PtrMap converts a string map of uint8 values into a string map of uint8pointers.

funcUint8PtrSlice¶added inv0.35.0

func Uint8PtrSlice(src []uint8) []*uint8

Uint8PtrSlice converts a slice of uint8 values into a slice of uint8pointers.

funcUint8Slice¶added inv0.36.0

func Uint8Slice(src []*uint8) []uint8

Uint8Slice converts a slice of uint8 pointers into a slice of uint8values.

funcUintMap¶added inv0.36.0

func UintMap(src map[string]*uint) map[string]uint

UintMap converts a string map of uint pointers uinto a string map ofuint values.

funcUintPtr¶added inv0.35.0

func UintPtr(vuint) *uint

UintPtr is a helper routine that allocates a new uint value to store vand returns a pointer to it.

funcUintPtrMap¶added inv0.35.0

func UintPtrMap(src map[string]uint) map[string]*uint

UintPtrMap converts a string map of uint values uinto a string map of uintpointers.

funcUintPtrSlice¶added inv0.35.0

func UintPtrSlice(src []uint) []*uint

UintPtrSlice converts a slice of uint values uinto a slice of uint pointers.

funcUintSlice¶added inv0.36.0

func UintSlice(src []*uint) []uint

UintSlice converts a slice of uint pointers uinto a slice of uintvalues.

typeAPI¶added inv0.7.2

type API struct {APIKeystringAPIEmailstringAPIUserServiceKeystringAPITokenstringBaseURLstringUserAgentstringDebugbool// contains filtered or unexported fields}

API holds the configuration for the current API client. A client should notbe modified concurrently.

func New(key, emailstring, opts ...Option) (*API,error)

func NewWithAPIToken(tokenstring, opts ...Option) (*API,error)

func NewWithUserServiceKey(keystring, opts ...Option) (*API,error)

func (api *API) APITokens(ctxcontext.Context) ([]APIToken,error)

func (api *API) AccessAuditLogs(ctxcontext.Context, accountIDstring, optsAccessAuditLogFilterOptions) ([]AccessAuditLogRecord,error)

api, err := cloudflare.New("deadbeef", "test@example.org")if err != nil {log.Fatal(err)}filterOpts := cloudflare.AccessAuditLogFilterOptions{}results, _ := api.AccessAuditLogs(context.Background(), "someaccountid", filterOpts)for _, record := range results {b, _ := json.Marshal(record)fmt.Println(string(b))}

func (api *API) AccessBookmark(ctxcontext.Context, accountID, bookmarkIDstring) (AccessBookmark,error)

func (api *API) AccessBookmarks(ctxcontext.Context, accountIDstring, pageOptsPaginationOptions) ([]AccessBookmark,ResultInfo,error)

func (api *API) AccessKeysConfig(ctxcontext.Context, accountIDstring) (AccessKeysConfig,error)

func (api *API) Account(ctxcontext.Context, accountIDstring) (Account,ResultInfo,error)

func (api *API) AccountAccessRule(ctxcontext.Context, accountIDstring, accessRuleIDstring) (*AccessRuleResponse,error)

func (api *API) AccountMember(ctxcontext.Context, accountIDstring, memberIDstring) (AccountMember,error)

func (api *API) AccountMembers(ctxcontext.Context, accountIDstring, pageOptsPaginationOptions) ([]AccountMember,ResultInfo,error)

func (api *API) Accounts(ctxcontext.Context, paramsAccountsListParams) ([]Account,ResultInfo,error)