zones

package
v4.0.0 Latest Latest
Warning

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

Go to latest
Published: Jan 10, 2025 License: Apache-2.0 Imports: 16 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 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 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 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 ActivationCheckService

type ActivationCheckService struct {
	Options []option.RequestOption
}

ActivationCheckService 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 NewActivationCheckService method instead.

func NewActivationCheckService

func NewActivationCheckService(opts ...option.RequestOption) (r *ActivationCheckService)

NewActivationCheckService 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 (*ActivationCheckService) Trigger

Triggeres a new activation check for a PENDING Zone. This can be triggered every 5 min for paygo/ent customers, every hour for FREE Zones.

type ActivationCheckTriggerParams

type ActivationCheckTriggerParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ActivationCheckTriggerResponse

type ActivationCheckTriggerResponse struct {
	// Identifier
	ID   string                             `json:"id"`
	JSON activationCheckTriggerResponseJSON `json:"-"`
}

func (*ActivationCheckTriggerResponse) UnmarshalJSON

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

type ActivationCheckTriggerResponseEnvelope

type ActivationCheckTriggerResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success ActivationCheckTriggerResponseEnvelopeSuccess `json:"success,required"`
	Result  ActivationCheckTriggerResponse                `json:"result"`
	JSON    activationCheckTriggerResponseEnvelopeJSON    `json:"-"`
}

func (*ActivationCheckTriggerResponseEnvelope) UnmarshalJSON

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

type ActivationCheckTriggerResponseEnvelopeSuccess

type ActivationCheckTriggerResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ActivationCheckTriggerResponseEnvelopeSuccessTrue ActivationCheckTriggerResponseEnvelopeSuccess = true
)

func (ActivationCheckTriggerResponseEnvelopeSuccess) IsKnown

type AdvancedDDoS

type AdvancedDDoS struct {
	// ID of the zone setting.
	ID AdvancedDDoSID `json:"id,required"`
	// Current value of the zone setting.
	Value AdvancedDDoSValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable AdvancedDDoSEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time        `json:"modified_on,nullable" format:"date-time"`
	JSON       advancedDDoSJSON `json:"-"`
}

Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.

func (*AdvancedDDoS) UnmarshalJSON

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

type AdvancedDDoSEditable

type AdvancedDDoSEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	AdvancedDDoSEditableTrue  AdvancedDDoSEditable = true
	AdvancedDDoSEditableFalse AdvancedDDoSEditable = false
)

func (AdvancedDDoSEditable) IsKnown

func (r AdvancedDDoSEditable) IsKnown() bool

type AdvancedDDoSID

type AdvancedDDoSID string

ID of the zone setting.

const (
	AdvancedDDoSIDAdvancedDDoS AdvancedDDoSID = "advanced_ddos"
)

func (AdvancedDDoSID) IsKnown

func (r AdvancedDDoSID) IsKnown() bool

type AdvancedDDoSParam

type AdvancedDDoSParam struct {
	// ID of the zone setting.
	ID param.Field[AdvancedDDoSID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[AdvancedDDoSValue] `json:"value,required"`
}

Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.

func (AdvancedDDoSParam) MarshalJSON

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

type AdvancedDDoSValue

type AdvancedDDoSValue string

Current value of the zone setting.

const (
	AdvancedDDoSValueOn  AdvancedDDoSValue = "on"
	AdvancedDDoSValueOff AdvancedDDoSValue = "off"
)

func (AdvancedDDoSValue) IsKnown

func (r AdvancedDDoSValue) IsKnown() bool

type AlwaysOnline

type AlwaysOnline struct {
	// ID of the zone setting.
	ID AlwaysOnlineID `json:"id,required"`
	// Current value of the zone setting.
	Value AlwaysOnlineValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable AlwaysOnlineEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time        `json:"modified_on,nullable" format:"date-time"`
	JSON       alwaysOnlineJSON `json:"-"`
}

When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.

func (*AlwaysOnline) UnmarshalJSON

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

type AlwaysOnlineEditable

type AlwaysOnlineEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	AlwaysOnlineEditableTrue  AlwaysOnlineEditable = true
	AlwaysOnlineEditableFalse AlwaysOnlineEditable = false
)

func (AlwaysOnlineEditable) IsKnown

func (r AlwaysOnlineEditable) IsKnown() bool

type AlwaysOnlineID

type AlwaysOnlineID string

ID of the zone setting.

const (
	AlwaysOnlineIDAlwaysOnline AlwaysOnlineID = "always_online"
)

func (AlwaysOnlineID) IsKnown

func (r AlwaysOnlineID) IsKnown() bool

type AlwaysOnlineParam

type AlwaysOnlineParam struct {
	// ID of the zone setting.
	ID param.Field[AlwaysOnlineID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[AlwaysOnlineValue] `json:"value,required"`
}

When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.

func (AlwaysOnlineParam) MarshalJSON

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

type AlwaysOnlineValue

type AlwaysOnlineValue string

Current value of the zone setting.

const (
	AlwaysOnlineValueOn  AlwaysOnlineValue = "on"
	AlwaysOnlineValueOff AlwaysOnlineValue = "off"
)

func (AlwaysOnlineValue) IsKnown

func (r AlwaysOnlineValue) IsKnown() bool

type AlwaysUseHTTPS

type AlwaysUseHTTPS struct {
	// If enabled, any ` http://“ URL is converted to  `https://` through a 301
	// redirect.
	ID   AlwaysUseHTTPSID   `json:"id"`
	JSON alwaysUseHTTPSJSON `json:"-"`
}

func (AlwaysUseHTTPS) ImplementsPageRulesPageRuleAction

func (r AlwaysUseHTTPS) ImplementsPageRulesPageRuleAction()

func (*AlwaysUseHTTPS) UnmarshalJSON

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

type AlwaysUseHTTPSID

type AlwaysUseHTTPSID string

If enabled, any ` http://“ URL is converted to `https://` through a 301 redirect.

const (
	AlwaysUseHTTPSIDAlwaysUseHTTPS AlwaysUseHTTPSID = "always_use_https"
)

func (AlwaysUseHTTPSID) IsKnown

func (r AlwaysUseHTTPSID) IsKnown() bool

type AlwaysUseHTTPSParam

type AlwaysUseHTTPSParam struct {
	// If enabled, any ` http://“ URL is converted to  `https://` through a 301
	// redirect.
	ID param.Field[AlwaysUseHTTPSID] `json:"id"`
}

func (AlwaysUseHTTPSParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r AlwaysUseHTTPSParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (AlwaysUseHTTPSParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r AlwaysUseHTTPSParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (AlwaysUseHTTPSParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r AlwaysUseHTTPSParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (AlwaysUseHTTPSParam) MarshalJSON

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

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 AutomaticHTTPSRewrites

type AutomaticHTTPSRewrites struct {
	// Turn on or off Automatic HTTPS Rewrites.
	ID AutomaticHTTPSRewritesID `json:"id"`
	// The status of Automatic HTTPS Rewrites.
	Value AutomaticHTTPSRewritesValue `json:"value"`
	JSON  automaticHTTPSRewritesJSON  `json:"-"`
}

func (AutomaticHTTPSRewrites) ImplementsPageRulesPageRuleAction

func (r AutomaticHTTPSRewrites) ImplementsPageRulesPageRuleAction()

func (*AutomaticHTTPSRewrites) UnmarshalJSON

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

type AutomaticHTTPSRewritesID

type AutomaticHTTPSRewritesID string

Turn on or off Automatic HTTPS Rewrites.

const (
	AutomaticHTTPSRewritesIDAutomaticHTTPSRewrites AutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

func (AutomaticHTTPSRewritesID) IsKnown

func (r AutomaticHTTPSRewritesID) IsKnown() bool

type AutomaticHTTPSRewritesParam

type AutomaticHTTPSRewritesParam struct {
	// Turn on or off Automatic HTTPS Rewrites.
	ID param.Field[AutomaticHTTPSRewritesID] `json:"id"`
	// The status of Automatic HTTPS Rewrites.
	Value param.Field[AutomaticHTTPSRewritesValue] `json:"value"`
}

func (AutomaticHTTPSRewritesParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r AutomaticHTTPSRewritesParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (AutomaticHTTPSRewritesParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r AutomaticHTTPSRewritesParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (AutomaticHTTPSRewritesParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r AutomaticHTTPSRewritesParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (AutomaticHTTPSRewritesParam) MarshalJSON

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

type AutomaticHTTPSRewritesValue

type AutomaticHTTPSRewritesValue string

The status of Automatic HTTPS Rewrites.

const (
	AutomaticHTTPSRewritesValueOn  AutomaticHTTPSRewritesValue = "on"
	AutomaticHTTPSRewritesValueOff AutomaticHTTPSRewritesValue = "off"
)

func (AutomaticHTTPSRewritesValue) IsKnown

func (r AutomaticHTTPSRewritesValue) IsKnown() bool

type AutomaticPlatformOptimization

type AutomaticPlatformOptimization struct {
	// Indicates whether or not
	// [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/)
	// is enabled.
	CacheByDeviceType bool `json:"cache_by_device_type,required"`
	// Indicates whether or not Cloudflare proxy is enabled.
	Cf bool `json:"cf,required"`
	// Indicates whether or not Automatic Platform Optimization is enabled.
	Enabled bool `json:"enabled,required"`
	// An array of hostnames where Automatic Platform Optimization for WordPress is
	// activated.
	Hostnames []string `json:"hostnames,required" format:"hostname"`
	// Indicates whether or not site is powered by WordPress.
	Wordpress bool `json:"wordpress,required"`
	// Indicates whether or not
	// [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is
	// installed.
	WpPlugin bool                              `json:"wp_plugin,required"`
	JSON     automaticPlatformOptimizationJSON `json:"-"`
}

func (*AutomaticPlatformOptimization) UnmarshalJSON

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

type AutomaticPlatformOptimizationParam

type AutomaticPlatformOptimizationParam struct {
	// Indicates whether or not
	// [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/)
	// is enabled.
	CacheByDeviceType param.Field[bool] `json:"cache_by_device_type,required"`
	// Indicates whether or not Cloudflare proxy is enabled.
	Cf param.Field[bool] `json:"cf,required"`
	// Indicates whether or not Automatic Platform Optimization is enabled.
	Enabled param.Field[bool] `json:"enabled,required"`
	// An array of hostnames where Automatic Platform Optimization for WordPress is
	// activated.
	Hostnames param.Field[[]string] `json:"hostnames,required" format:"hostname"`
	// Indicates whether or not site is powered by WordPress.
	Wordpress param.Field[bool] `json:"wordpress,required"`
	// Indicates whether or not
	// [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is
	// installed.
	WpPlugin param.Field[bool] `json:"wp_plugin,required"`
}

func (AutomaticPlatformOptimizationParam) MarshalJSON

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

type AvailableRatePlan

type AvailableRatePlan struct {
	// Identifier
	ID string `json:"id"`
	// Indicates whether you can subscribe to this plan.
	CanSubscribe bool `json:"can_subscribe"`
	// The monetary unit in which pricing information is displayed.
	Currency string `json:"currency"`
	// Indicates whether this plan is managed externally.
	ExternallyManaged bool `json:"externally_managed"`
	// The frequency at which you will be billed for this plan.
	Frequency AvailableRatePlanFrequency `json:"frequency"`
	// Indicates whether you are currently subscribed to this plan.
	IsSubscribed bool `json:"is_subscribed"`
	// Indicates whether this plan has a legacy discount applied.
	LegacyDiscount bool `json:"legacy_discount"`
	// The legacy identifier for this rate plan, if any.
	LegacyID string `json:"legacy_id"`
	// The plan name.
	Name string `json:"name"`
	// The amount you will be billed for this plan.
	Price float64               `json:"price"`
	JSON  availableRatePlanJSON `json:"-"`
}

func (*AvailableRatePlan) UnmarshalJSON

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

type AvailableRatePlanFrequency

type AvailableRatePlanFrequency string

The frequency at which you will be billed for this plan.

const (
	AvailableRatePlanFrequencyWeekly    AvailableRatePlanFrequency = "weekly"
	AvailableRatePlanFrequencyMonthly   AvailableRatePlanFrequency = "monthly"
	AvailableRatePlanFrequencyQuarterly AvailableRatePlanFrequency = "quarterly"
	AvailableRatePlanFrequencyYearly    AvailableRatePlanFrequency = "yearly"
)

func (AvailableRatePlanFrequency) IsKnown

func (r AvailableRatePlanFrequency) IsKnown() bool

type Brotli

type Brotli struct {
	// ID of the zone setting.
	ID BrotliID `json:"id,required"`
	// Current value of the zone setting.
	Value BrotliValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable BrotliEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time  `json:"modified_on,nullable" format:"date-time"`
	JSON       brotliJSON `json:"-"`
}

When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.

func (*Brotli) UnmarshalJSON

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

type BrotliEditable

type BrotliEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	BrotliEditableTrue  BrotliEditable = true
	BrotliEditableFalse BrotliEditable = false
)

func (BrotliEditable) IsKnown

func (r BrotliEditable) IsKnown() bool

type BrotliID

type BrotliID string

ID of the zone setting.

const (
	BrotliIDBrotli BrotliID = "brotli"
)

func (BrotliID) IsKnown

func (r BrotliID) IsKnown() bool

type BrotliParam

type BrotliParam struct {
	// ID of the zone setting.
	ID param.Field[BrotliID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[BrotliValue] `json:"value,required"`
}

When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.

func (BrotliParam) MarshalJSON

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

type BrotliValue

type BrotliValue string

Current value of the zone setting.

const (
	BrotliValueOff BrotliValue = "off"
	BrotliValueOn  BrotliValue = "on"
)

func (BrotliValue) IsKnown

func (r BrotliValue) IsKnown() bool

type BrowserCacheTTL

type BrowserCacheTTL struct {
	// Control how long resources cached by client browsers remain valid.
	ID BrowserCacheTTLID `json:"id"`
	// The number of seconds to cache resources for. The API prohibits setting this to
	// 0 for non-Enterprise domains.
	Value int64               `json:"value"`
	JSON  browserCacheTTLJSON `json:"-"`
}

func (BrowserCacheTTL) ImplementsPageRulesPageRuleAction

func (r BrowserCacheTTL) ImplementsPageRulesPageRuleAction()

func (*BrowserCacheTTL) UnmarshalJSON

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

type BrowserCacheTTLID

type BrowserCacheTTLID string

Control how long resources cached by client browsers remain valid.

const (
	BrowserCacheTTLIDBrowserCacheTTL BrowserCacheTTLID = "browser_cache_ttl"
)

func (BrowserCacheTTLID) IsKnown

func (r BrowserCacheTTLID) IsKnown() bool

type BrowserCacheTTLParam

type BrowserCacheTTLParam struct {
	// Control how long resources cached by client browsers remain valid.
	ID param.Field[BrowserCacheTTLID] `json:"id"`
	// The number of seconds to cache resources for. The API prohibits setting this to
	// 0 for non-Enterprise domains.
	Value param.Field[int64] `json:"value"`
}

func (BrowserCacheTTLParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r BrowserCacheTTLParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (BrowserCacheTTLParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r BrowserCacheTTLParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (BrowserCacheTTLParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r BrowserCacheTTLParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (BrowserCacheTTLParam) MarshalJSON

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

type BrowserCheck

type BrowserCheck struct {
	// Inspect the visitor's browser for headers commonly associated with spammers and
	// certain bots.
	ID BrowserCheckID `json:"id"`
	// The status of Browser Integrity Check.
	Value BrowserCheckValue `json:"value"`
	JSON  browserCheckJSON  `json:"-"`
}

func (BrowserCheck) ImplementsPageRulesPageRuleAction

func (r BrowserCheck) ImplementsPageRulesPageRuleAction()

func (*BrowserCheck) UnmarshalJSON

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

type BrowserCheckID

type BrowserCheckID string

Inspect the visitor's browser for headers commonly associated with spammers and certain bots.

const (
	BrowserCheckIDBrowserCheck BrowserCheckID = "browser_check"
)

func (BrowserCheckID) IsKnown

func (r BrowserCheckID) IsKnown() bool

type BrowserCheckParam

type BrowserCheckParam struct {
	// Inspect the visitor's browser for headers commonly associated with spammers and
	// certain bots.
	ID param.Field[BrowserCheckID] `json:"id"`
	// The status of Browser Integrity Check.
	Value param.Field[BrowserCheckValue] `json:"value"`
}

func (BrowserCheckParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r BrowserCheckParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (BrowserCheckParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r BrowserCheckParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (BrowserCheckParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r BrowserCheckParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (BrowserCheckParam) MarshalJSON

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

type BrowserCheckValue

type BrowserCheckValue string

The status of Browser Integrity Check.

const (
	BrowserCheckValueOn  BrowserCheckValue = "on"
	BrowserCheckValueOff BrowserCheckValue = "off"
)

func (BrowserCheckValue) IsKnown

func (r BrowserCheckValue) IsKnown() bool

type CacheLevel

type CacheLevel struct {
	// Apply custom caching based on the option selected.
	ID CacheLevelID `json:"id"`
	//   - `bypass`: Cloudflare does not cache.
	//   - `basic`: Delivers resources from cache when there is no query string.
	//   - `simplified`: Delivers the same resource to everyone independent of the query
	//     string.
	//   - `aggressive`: Caches all static content that has a query string.
	//   - `cache_everything`: Treats all content as static and caches all file types
	//     beyond the
	//     [Cloudflare default cached content](https://developers.cloudflare.com/cache/concepts/default-cache-behavior/#default-cached-file-extensions).
	Value CacheLevelValue `json:"value"`
	JSON  cacheLevelJSON  `json:"-"`
}

func (CacheLevel) ImplementsPageRulesPageRuleAction

func (r CacheLevel) ImplementsPageRulesPageRuleAction()

func (*CacheLevel) UnmarshalJSON

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

type CacheLevelID

type CacheLevelID string

Apply custom caching based on the option selected.

const (
	CacheLevelIDCacheLevel CacheLevelID = "cache_level"
)

func (CacheLevelID) IsKnown

func (r CacheLevelID) IsKnown() bool

type CacheLevelParam

type CacheLevelParam struct {
	// Apply custom caching based on the option selected.
	ID param.Field[CacheLevelID] `json:"id"`
	//   - `bypass`: Cloudflare does not cache.
	//   - `basic`: Delivers resources from cache when there is no query string.
	//   - `simplified`: Delivers the same resource to everyone independent of the query
	//     string.
	//   - `aggressive`: Caches all static content that has a query string.
	//   - `cache_everything`: Treats all content as static and caches all file types
	//     beyond the
	//     [Cloudflare default cached content](https://developers.cloudflare.com/cache/concepts/default-cache-behavior/#default-cached-file-extensions).
	Value param.Field[CacheLevelValue] `json:"value"`
}

func (CacheLevelParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r CacheLevelParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (CacheLevelParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r CacheLevelParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (CacheLevelParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r CacheLevelParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (CacheLevelParam) MarshalJSON

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

type CacheLevelValue

type CacheLevelValue string
const (
	CacheLevelValueBypass          CacheLevelValue = "bypass"
	CacheLevelValueBasic           CacheLevelValue = "basic"
	CacheLevelValueSimplified      CacheLevelValue = "simplified"
	CacheLevelValueAggressive      CacheLevelValue = "aggressive"
	CacheLevelValueCacheEverything CacheLevelValue = "cache_everything"
)

func (CacheLevelValue) IsKnown

func (r CacheLevelValue) IsKnown() bool

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 ChallengeTTL

type ChallengeTTL struct {
	// ID of the zone setting.
	ID ChallengeTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value ChallengeTTLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ChallengeTTLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time        `json:"modified_on,nullable" format:"date-time"`
	JSON       challengeTTLJSON `json:"-"`
}

Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).

func (*ChallengeTTL) UnmarshalJSON

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

type ChallengeTTLEditable

type ChallengeTTLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	ChallengeTTLEditableTrue  ChallengeTTLEditable = true
	ChallengeTTLEditableFalse ChallengeTTLEditable = false
)

func (ChallengeTTLEditable) IsKnown

func (r ChallengeTTLEditable) IsKnown() bool

type ChallengeTTLID

type ChallengeTTLID string

ID of the zone setting.

const (
	ChallengeTTLIDChallengeTTL ChallengeTTLID = "challenge_ttl"
)

func (ChallengeTTLID) IsKnown

func (r ChallengeTTLID) IsKnown() bool

type ChallengeTTLParam

type ChallengeTTLParam struct {
	// ID of the zone setting.
	ID param.Field[ChallengeTTLID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ChallengeTTLValue] `json:"value,required"`
}

Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).

func (ChallengeTTLParam) MarshalJSON

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

type ChallengeTTLValue

type ChallengeTTLValue float64

Current value of the zone setting.

const (
	ChallengeTTLValue300      ChallengeTTLValue = 300
	ChallengeTTLValue900      ChallengeTTLValue = 900
	ChallengeTTLValue1800     ChallengeTTLValue = 1800
	ChallengeTTLValue2700     ChallengeTTLValue = 2700
	ChallengeTTLValue3600     ChallengeTTLValue = 3600
	ChallengeTTLValue7200     ChallengeTTLValue = 7200
	ChallengeTTLValue10800    ChallengeTTLValue = 10800
	ChallengeTTLValue14400    ChallengeTTLValue = 14400
	ChallengeTTLValue28800    ChallengeTTLValue = 28800
	ChallengeTTLValue57600    ChallengeTTLValue = 57600
	ChallengeTTLValue86400    ChallengeTTLValue = 86400
	ChallengeTTLValue604800   ChallengeTTLValue = 604800
	ChallengeTTLValue2592000  ChallengeTTLValue = 2592000
	ChallengeTTLValue31536000 ChallengeTTLValue = 31536000
)

func (ChallengeTTLValue) IsKnown

func (r ChallengeTTLValue) IsKnown() bool

type Ciphers

type Ciphers struct {
	// ID of the zone setting.
	ID CiphersID `json:"id,required"`
	// Current value of the zone setting.
	Value []string `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable CiphersEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time   `json:"modified_on,nullable" format:"date-time"`
	JSON       ciphersJSON `json:"-"`
}

An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.

func (*Ciphers) UnmarshalJSON

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

type CiphersEditable

type CiphersEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	CiphersEditableTrue  CiphersEditable = true
	CiphersEditableFalse CiphersEditable = false
)

func (CiphersEditable) IsKnown

func (r CiphersEditable) IsKnown() bool

type CiphersID

type CiphersID string

ID of the zone setting.

const (
	CiphersIDCiphers CiphersID = "ciphers"
)

func (CiphersID) IsKnown

func (r CiphersID) IsKnown() bool

type CiphersParam

type CiphersParam struct {
	// ID of the zone setting.
	ID param.Field[CiphersID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[[]string] `json:"value,required"`
}

An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.

func (CiphersParam) MarshalJSON

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

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 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 CustomNameserverGetParams

type CustomNameserverGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type CustomNameserverGetResponse

type CustomNameserverGetResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CustomNameserverGetResponseSuccess `json:"success,required"`
	// Whether zone uses account-level custom nameservers.
	Enabled bool `json:"enabled"`
	// The number of the name server set to assign to the zone.
	NSSet      float64                               `json:"ns_set"`
	ResultInfo CustomNameserverGetResponseResultInfo `json:"result_info"`
	JSON       customNameserverGetResponseJSON       `json:"-"`
}

func (*CustomNameserverGetResponse) UnmarshalJSON

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

type CustomNameserverGetResponseResultInfo

type CustomNameserverGetResponseResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                   `json:"total_count"`
	JSON       customNameserverGetResponseResultInfoJSON `json:"-"`
}

func (*CustomNameserverGetResponseResultInfo) UnmarshalJSON

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

type CustomNameserverGetResponseSuccess

type CustomNameserverGetResponseSuccess bool

Whether the API call was successful

const (
	CustomNameserverGetResponseSuccessTrue CustomNameserverGetResponseSuccess = true
)

func (CustomNameserverGetResponseSuccess) IsKnown

type CustomNameserverService

type CustomNameserverService struct {
	Options []option.RequestOption
}

CustomNameserverService 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 NewCustomNameserverService method instead.

func NewCustomNameserverService

func NewCustomNameserverService(opts ...option.RequestOption) (r *CustomNameserverService)

NewCustomNameserverService 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 (*CustomNameserverService) Get

Get metadata for account-level custom nameservers on a zone.

Deprecated in favor of [Show DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-list-dns-settings).

func (*CustomNameserverService) Update

Set metadata for account-level custom nameservers on a zone.

If you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.

Deprecated in favor of [Update DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-update-dns-settings).

type CustomNameserverUpdateParams

type CustomNameserverUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Whether zone uses account-level custom nameservers.
	Enabled param.Field[bool] `json:"enabled"`
	// The number of the name server set to assign to the zone.
	NSSet param.Field[float64] `json:"ns_set"`
}

func (CustomNameserverUpdateParams) MarshalJSON

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

type CustomNameserverUpdateResponseEnvelope

type CustomNameserverUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    CustomNameserverUpdateResponseEnvelopeSuccess    `json:"success,required"`
	Result     []string                                         `json:"result"`
	ResultInfo CustomNameserverUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       customNameserverUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*CustomNameserverUpdateResponseEnvelope) UnmarshalJSON

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

type CustomNameserverUpdateResponseEnvelopeResultInfo

type CustomNameserverUpdateResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                              `json:"total_count"`
	JSON       customNameserverUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*CustomNameserverUpdateResponseEnvelopeResultInfo) UnmarshalJSON

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

type CustomNameserverUpdateResponseEnvelopeSuccess

type CustomNameserverUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	CustomNameserverUpdateResponseEnvelopeSuccessTrue CustomNameserverUpdateResponseEnvelopeSuccess = true
)

func (CustomNameserverUpdateResponseEnvelopeSuccess) IsKnown

type DevelopmentMode

type DevelopmentMode struct {
	// ID of the zone setting.
	ID DevelopmentModeID `json:"id,required"`
	// Current value of the zone setting.
	Value DevelopmentModeValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable DevelopmentModeEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the zone setting. Notes: The interval (in seconds) from when
	// development mode expires (positive integer) or last expired (negative integer)
	// for the domain. If development mode has never been enabled, this value is false.
	TimeRemaining float64             `json:"time_remaining"`
	JSON          developmentModeJSON `json:"-"`
}

Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.

func (*DevelopmentMode) UnmarshalJSON

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

type DevelopmentModeEditable

type DevelopmentModeEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	DevelopmentModeEditableTrue  DevelopmentModeEditable = true
	DevelopmentModeEditableFalse DevelopmentModeEditable = false
)

func (DevelopmentModeEditable) IsKnown

func (r DevelopmentModeEditable) IsKnown() bool

type DevelopmentModeID

type DevelopmentModeID string

ID of the zone setting.

const (
	DevelopmentModeIDDevelopmentMode DevelopmentModeID = "development_mode"
)

func (DevelopmentModeID) IsKnown

func (r DevelopmentModeID) IsKnown() bool

type DevelopmentModeParam

type DevelopmentModeParam struct {
	// ID of the zone setting.
	ID param.Field[DevelopmentModeID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[DevelopmentModeValue] `json:"value,required"`
}

Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.

func (DevelopmentModeParam) MarshalJSON

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

type DevelopmentModeValue

type DevelopmentModeValue string

Current value of the zone setting.

const (
	DevelopmentModeValueOn  DevelopmentModeValue = "on"
	DevelopmentModeValueOff DevelopmentModeValue = "off"
)

func (DevelopmentModeValue) IsKnown

func (r DevelopmentModeValue) IsKnown() bool

type EarlyHints

type EarlyHints struct {
	// ID of the zone setting.
	ID EarlyHintsID `json:"id,required"`
	// Current value of the zone setting.
	Value EarlyHintsValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable EarlyHintsEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time      `json:"modified_on,nullable" format:"date-time"`
	JSON       earlyHintsJSON `json:"-"`
}

When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.

func (*EarlyHints) UnmarshalJSON

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

type EarlyHintsEditable

type EarlyHintsEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	EarlyHintsEditableTrue  EarlyHintsEditable = true
	EarlyHintsEditableFalse EarlyHintsEditable = false
)

func (EarlyHintsEditable) IsKnown

func (r EarlyHintsEditable) IsKnown() bool

type EarlyHintsID

type EarlyHintsID string

ID of the zone setting.

const (
	EarlyHintsIDEarlyHints EarlyHintsID = "early_hints"
)

func (EarlyHintsID) IsKnown

func (r EarlyHintsID) IsKnown() bool

type EarlyHintsParam

type EarlyHintsParam struct {
	// ID of the zone setting.
	ID param.Field[EarlyHintsID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[EarlyHintsValue] `json:"value,required"`
}

When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.

func (EarlyHintsParam) MarshalJSON

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

type EarlyHintsValue

type EarlyHintsValue string

Current value of the zone setting.

const (
	EarlyHintsValueOn  EarlyHintsValue = "on"
	EarlyHintsValueOff EarlyHintsValue = "off"
)

func (EarlyHintsValue) IsKnown

func (r EarlyHintsValue) IsKnown() bool

type EmailObfuscation

type EmailObfuscation struct {
	// Turn on or off **Email Obfuscation**.
	ID EmailObfuscationID `json:"id"`
	// The status of Email Obfuscation.
	Value EmailObfuscationValue `json:"value"`
	JSON  emailObfuscationJSON  `json:"-"`
}

func (EmailObfuscation) ImplementsPageRulesPageRuleAction

func (r EmailObfuscation) ImplementsPageRulesPageRuleAction()

func (*EmailObfuscation) UnmarshalJSON

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

type EmailObfuscationID

type EmailObfuscationID string

Turn on or off **Email Obfuscation**.

const (
	EmailObfuscationIDEmailObfuscation EmailObfuscationID = "email_obfuscation"
)

func (EmailObfuscationID) IsKnown

func (r EmailObfuscationID) IsKnown() bool

type EmailObfuscationParam

type EmailObfuscationParam struct {
	// Turn on or off **Email Obfuscation**.
	ID param.Field[EmailObfuscationID] `json:"id"`
	// The status of Email Obfuscation.
	Value param.Field[EmailObfuscationValue] `json:"value"`
}

func (EmailObfuscationParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r EmailObfuscationParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (EmailObfuscationParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r EmailObfuscationParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (EmailObfuscationParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r EmailObfuscationParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (EmailObfuscationParam) MarshalJSON

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

type EmailObfuscationValue

type EmailObfuscationValue string

The status of Email Obfuscation.

const (
	EmailObfuscationValueOn  EmailObfuscationValue = "on"
	EmailObfuscationValueOff EmailObfuscationValue = "off"
)

func (EmailObfuscationValue) IsKnown

func (r EmailObfuscationValue) IsKnown() bool

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type H2Prioritization

type H2Prioritization struct {
	// ID of the zone setting.
	ID H2PrioritizationID `json:"id,required"`
	// Current value of the zone setting.
	Value H2PrioritizationValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable H2PrioritizationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time            `json:"modified_on,nullable" format:"date-time"`
	JSON       h2PrioritizationJSON `json:"-"`
}

HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.

func (*H2Prioritization) UnmarshalJSON

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

type H2PrioritizationEditable

type H2PrioritizationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	H2PrioritizationEditableTrue  H2PrioritizationEditable = true
	H2PrioritizationEditableFalse H2PrioritizationEditable = false
)

func (H2PrioritizationEditable) IsKnown

func (r H2PrioritizationEditable) IsKnown() bool

type H2PrioritizationID

type H2PrioritizationID string

ID of the zone setting.

const (
	H2PrioritizationIDH2Prioritization H2PrioritizationID = "h2_prioritization"
)

func (H2PrioritizationID) IsKnown

func (r H2PrioritizationID) IsKnown() bool

type H2PrioritizationParam

type H2PrioritizationParam struct {
	// ID of the zone setting.
	ID param.Field[H2PrioritizationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[H2PrioritizationValue] `json:"value,required"`
}

HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.

func (H2PrioritizationParam) MarshalJSON

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

type H2PrioritizationValue

type H2PrioritizationValue string

Current value of the zone setting.

const (
	H2PrioritizationValueOn     H2PrioritizationValue = "on"
	H2PrioritizationValueOff    H2PrioritizationValue = "off"
	H2PrioritizationValueCustom H2PrioritizationValue = "custom"
)

func (H2PrioritizationValue) IsKnown

func (r H2PrioritizationValue) IsKnown() bool

type HTTP2

type HTTP2 struct {
	// ID of the zone setting.
	ID HTTP2ID `json:"id,required"`
	// Current value of the zone setting.
	Value HTTP2Value `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable HTTP2Editable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	JSON       http2JSON `json:"-"`
}

HTTP2 enabled for this zone.

func (*HTTP2) UnmarshalJSON

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

type HTTP2Editable

type HTTP2Editable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	HTTP2EditableTrue  HTTP2Editable = true
	HTTP2EditableFalse HTTP2Editable = false
)

func (HTTP2Editable) IsKnown

func (r HTTP2Editable) IsKnown() bool

type HTTP2ID

type HTTP2ID string

ID of the zone setting.

const (
	HTTP2IDHTTP2 HTTP2ID = "http2"
)

func (HTTP2ID) IsKnown

func (r HTTP2ID) IsKnown() bool

type HTTP2Param

type HTTP2Param struct {
	// ID of the zone setting.
	ID param.Field[HTTP2ID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[HTTP2Value] `json:"value,required"`
}

HTTP2 enabled for this zone.

func (HTTP2Param) MarshalJSON

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

type HTTP2Value

type HTTP2Value string

Current value of the zone setting.

const (
	HTTP2ValueOn  HTTP2Value = "on"
	HTTP2ValueOff HTTP2Value = "off"
)

func (HTTP2Value) IsKnown

func (r HTTP2Value) IsKnown() bool

type HTTP3

type HTTP3 struct {
	// ID of the zone setting.
	ID HTTP3ID `json:"id,required"`
	// Current value of the zone setting.
	Value HTTP3Value `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable HTTP3Editable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	JSON       http3JSON `json:"-"`
}

HTTP3 enabled for this zone.

func (*HTTP3) UnmarshalJSON

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

type HTTP3Editable

type HTTP3Editable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	HTTP3EditableTrue  HTTP3Editable = true
	HTTP3EditableFalse HTTP3Editable = false
)

func (HTTP3Editable) IsKnown

func (r HTTP3Editable) IsKnown() bool

type HTTP3ID

type HTTP3ID string

ID of the zone setting.

const (
	HTTP3IDHTTP3 HTTP3ID = "http3"
)

func (HTTP3ID) IsKnown

func (r HTTP3ID) IsKnown() bool

type HTTP3Param

type HTTP3Param struct {
	// ID of the zone setting.
	ID param.Field[HTTP3ID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[HTTP3Value] `json:"value,required"`
}

HTTP3 enabled for this zone.

func (HTTP3Param) MarshalJSON

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

type HTTP3Value

type HTTP3Value string

Current value of the zone setting.

const (
	HTTP3ValueOn  HTTP3Value = "on"
	HTTP3ValueOff HTTP3Value = "off"
)

func (HTTP3Value) IsKnown

func (r HTTP3Value) IsKnown() bool

type HoldDeleteParams

type HoldDeleteParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// If `hold_after` is provided, the hold will be temporarily disabled, then
	// automatically re-enabled by the system at the time specified in this
	// RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely.
	HoldAfter param.Field[string] `query:"hold_after"`
}

func (HoldDeleteParams) URLQuery

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

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

type HoldDeleteResponseEnvelope

type HoldDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ZoneHold              `json:"result,required"`
	// Whether the API call was successful
	Success HoldDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    holdDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*HoldDeleteResponseEnvelope) UnmarshalJSON

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

type HoldDeleteResponseEnvelopeSuccess

type HoldDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HoldDeleteResponseEnvelopeSuccessTrue HoldDeleteResponseEnvelopeSuccess = true
)

func (HoldDeleteResponseEnvelopeSuccess) IsKnown

type HoldEditParams

type HoldEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// If `hold_after` is provided and future-dated, the hold will be temporarily
	// disabled, then automatically re-enabled by the system at the time specified in
	// this RFC3339-formatted timestamp. A past-dated `hold_after` value will have no
	// effect on an existing, enabled hold. Providing an empty string will set its
	// value to the current time.
	HoldAfter param.Field[string] `json:"hold_after"`
	// If `true`, the zone hold will extend to block any subdomain of the given zone,
	// as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with
	// the hostname 'example.com' and include_subdomains=true will block 'example.com',
	// 'staging.example.com', 'api.staging.example.com', etc.
	IncludeSubdomains param.Field[bool] `json:"include_subdomains"`
}

func (HoldEditParams) MarshalJSON

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

type HoldEditResponseEnvelope

type HoldEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ZoneHold              `json:"result,required"`
	// Whether the API call was successful
	Success HoldEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    holdEditResponseEnvelopeJSON    `json:"-"`
}

func (*HoldEditResponseEnvelope) UnmarshalJSON

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

type HoldEditResponseEnvelopeSuccess

type HoldEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HoldEditResponseEnvelopeSuccessTrue HoldEditResponseEnvelopeSuccess = true
)

func (HoldEditResponseEnvelopeSuccess) IsKnown

type HoldGetParams

type HoldGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HoldGetResponseEnvelope

type HoldGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ZoneHold              `json:"result,required"`
	// Whether the API call was successful
	Success HoldGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    holdGetResponseEnvelopeJSON    `json:"-"`
}

func (*HoldGetResponseEnvelope) UnmarshalJSON

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

type HoldGetResponseEnvelopeSuccess

type HoldGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HoldGetResponseEnvelopeSuccessTrue HoldGetResponseEnvelopeSuccess = true
)

func (HoldGetResponseEnvelopeSuccess) IsKnown

type HoldNewParams

type HoldNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// If provided, the zone hold will extend to block any subdomain of the given zone,
	// as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with
	// the hostname 'example.com' and include_subdomains=true will block 'example.com',
	// 'staging.example.com', 'api.staging.example.com', etc.
	IncludeSubdomains param.Field[bool] `query:"include_subdomains"`
}

func (HoldNewParams) URLQuery

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

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

type HoldNewResponseEnvelope

type HoldNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ZoneHold              `json:"result,required"`
	// Whether the API call was successful
	Success HoldNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    holdNewResponseEnvelopeJSON    `json:"-"`
}

func (*HoldNewResponseEnvelope) UnmarshalJSON

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

type HoldNewResponseEnvelopeSuccess

type HoldNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HoldNewResponseEnvelopeSuccessTrue HoldNewResponseEnvelopeSuccess = true
)

func (HoldNewResponseEnvelopeSuccess) IsKnown

type HoldService

type HoldService struct {
	Options []option.RequestOption
}

HoldService 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 NewHoldService method instead.

func NewHoldService

func NewHoldService(opts ...option.RequestOption) (r *HoldService)

NewHoldService 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 (*HoldService) Delete

func (r *HoldService) Delete(ctx context.Context, params HoldDeleteParams, opts ...option.RequestOption) (res *ZoneHold, err error)

Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the creation and activation of zones with this zone's hostname.

func (*HoldService) Edit

func (r *HoldService) Edit(ctx context.Context, params HoldEditParams, opts ...option.RequestOption) (res *ZoneHold, err error)

Update the `hold_after` and/or `include_subdomains` values on an existing zone hold. The hold is enabled if the `hold_after` date-time value is in the past.

func (*HoldService) Get

func (r *HoldService) Get(ctx context.Context, query HoldGetParams, opts ...option.RequestOption) (res *ZoneHold, err error)

Retrieve whether the zone is subject to a zone hold, and metadata about the hold.

func (*HoldService) New

func (r *HoldService) New(ctx context.Context, params HoldNewParams, opts ...option.RequestOption) (res *ZoneHold, err error)

Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname.

type HotlinkProtection

type HotlinkProtection struct {
	// ID of the zone setting.
	ID HotlinkProtectionID `json:"id,required"`
	// Current value of the zone setting.
	Value HotlinkProtectionValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable HotlinkProtectionEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time             `json:"modified_on,nullable" format:"date-time"`
	JSON       hotlinkProtectionJSON `json:"-"`
}

When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).

func (*HotlinkProtection) UnmarshalJSON

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

type HotlinkProtectionEditable

type HotlinkProtectionEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	HotlinkProtectionEditableTrue  HotlinkProtectionEditable = true
	HotlinkProtectionEditableFalse HotlinkProtectionEditable = false
)

func (HotlinkProtectionEditable) IsKnown

func (r HotlinkProtectionEditable) IsKnown() bool

type HotlinkProtectionID

type HotlinkProtectionID string

ID of the zone setting.

const (
	HotlinkProtectionIDHotlinkProtection HotlinkProtectionID = "hotlink_protection"
)

func (HotlinkProtectionID) IsKnown

func (r HotlinkProtectionID) IsKnown() bool

type HotlinkProtectionParam

type HotlinkProtectionParam struct {
	// ID of the zone setting.
	ID param.Field[HotlinkProtectionID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[HotlinkProtectionValue] `json:"value,required"`
}

When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).

func (HotlinkProtectionParam) MarshalJSON

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

type HotlinkProtectionValue

type HotlinkProtectionValue string

Current value of the zone setting.

const (
	HotlinkProtectionValueOn  HotlinkProtectionValue = "on"
	HotlinkProtectionValueOff HotlinkProtectionValue = "off"
)

func (HotlinkProtectionValue) IsKnown

func (r HotlinkProtectionValue) IsKnown() bool

type IPGeolocation

type IPGeolocation struct {
	// Cloudflare adds a CF-IPCountry HTTP header containing the country code that
	// corresponds to the visitor.
	ID IPGeolocationID `json:"id"`
	// The status of adding the IP Geolocation Header.
	Value IPGeolocationValue `json:"value"`
	JSON  ipGeolocationJSON  `json:"-"`
}

func (IPGeolocation) ImplementsPageRulesPageRuleAction

func (r IPGeolocation) ImplementsPageRulesPageRuleAction()

func (*IPGeolocation) UnmarshalJSON

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

type IPGeolocationID

type IPGeolocationID string

Cloudflare adds a CF-IPCountry HTTP header containing the country code that corresponds to the visitor.

const (
	IPGeolocationIDIPGeolocation IPGeolocationID = "ip_geolocation"
)

func (IPGeolocationID) IsKnown

func (r IPGeolocationID) IsKnown() bool

type IPGeolocationParam

type IPGeolocationParam struct {
	// Cloudflare adds a CF-IPCountry HTTP header containing the country code that
	// corresponds to the visitor.
	ID param.Field[IPGeolocationID] `json:"id"`
	// The status of adding the IP Geolocation Header.
	Value param.Field[IPGeolocationValue] `json:"value"`
}

func (IPGeolocationParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r IPGeolocationParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (IPGeolocationParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r IPGeolocationParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (IPGeolocationParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r IPGeolocationParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (IPGeolocationParam) MarshalJSON

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

type IPGeolocationValue

type IPGeolocationValue string

The status of adding the IP Geolocation Header.

const (
	IPGeolocationValueOn  IPGeolocationValue = "on"
	IPGeolocationValueOff IPGeolocationValue = "off"
)

func (IPGeolocationValue) IsKnown

func (r IPGeolocationValue) IsKnown() bool

type IPV6

type IPV6 struct {
	// ID of the zone setting.
	ID IPV6ID `json:"id,required"`
	// Current value of the zone setting.
	Value IPV6Value `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable IPV6Editable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	JSON       ipv6JSON  `json:"-"`
}

Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).

func (*IPV6) UnmarshalJSON

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

type IPV6Editable

type IPV6Editable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	IPV6EditableTrue  IPV6Editable = true
	IPV6EditableFalse IPV6Editable = false
)

func (IPV6Editable) IsKnown

func (r IPV6Editable) IsKnown() bool

type IPV6ID

type IPV6ID string

ID of the zone setting.

const (
	IPV6IDIPV6 IPV6ID = "ipv6"
)

func (IPV6ID) IsKnown

func (r IPV6ID) IsKnown() bool

type IPV6Param

type IPV6Param struct {
	// ID of the zone setting.
	ID param.Field[IPV6ID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[IPV6Value] `json:"value,required"`
}

Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).

func (IPV6Param) MarshalJSON

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

type IPV6Value

type IPV6Value string

Current value of the zone setting.

const (
	IPV6ValueOff IPV6Value = "off"
	IPV6ValueOn  IPV6Value = "on"
)

func (IPV6Value) IsKnown

func (r IPV6Value) IsKnown() bool

type ImageResizing

type ImageResizing struct {
	// ID of the zone setting.
	ID ImageResizingID `json:"id,required"`
	// Current value of the zone setting.
	Value ImageResizingValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ImageResizingEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time         `json:"modified_on,nullable" format:"date-time"`
	JSON       imageResizingJSON `json:"-"`
}

Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.

func (*ImageResizing) UnmarshalJSON

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

type ImageResizingEditable

type ImageResizingEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	ImageResizingEditableTrue  ImageResizingEditable = true
	ImageResizingEditableFalse ImageResizingEditable = false
)

func (ImageResizingEditable) IsKnown

func (r ImageResizingEditable) IsKnown() bool

type ImageResizingID

type ImageResizingID string

ID of the zone setting.

const (
	ImageResizingIDImageResizing ImageResizingID = "image_resizing"
)

func (ImageResizingID) IsKnown

func (r ImageResizingID) IsKnown() bool

type ImageResizingParam

type ImageResizingParam struct {
	// ID of the zone setting.
	ID param.Field[ImageResizingID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ImageResizingValue] `json:"value,required"`
}

Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.

func (ImageResizingParam) MarshalJSON

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

type ImageResizingValue

type ImageResizingValue string

Current value of the zone setting.

const (
	ImageResizingValueOn   ImageResizingValue = "on"
	ImageResizingValueOff  ImageResizingValue = "off"
	ImageResizingValueOpen ImageResizingValue = "open"
)

func (ImageResizingValue) IsKnown

func (r ImageResizingValue) IsKnown() bool

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 MinTLSVersion

type MinTLSVersion struct {
	// ID of the zone setting.
	ID MinTLSVersionID `json:"id,required"`
	// Current value of the zone setting.
	Value MinTLSVersionValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable MinTLSVersionEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time         `json:"modified_on,nullable" format:"date-time"`
	JSON       minTLSVersionJSON `json:"-"`
}

Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.

func (*MinTLSVersion) UnmarshalJSON

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

type MinTLSVersionEditable

type MinTLSVersionEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	MinTLSVersionEditableTrue  MinTLSVersionEditable = true
	MinTLSVersionEditableFalse MinTLSVersionEditable = false
)

func (MinTLSVersionEditable) IsKnown

func (r MinTLSVersionEditable) IsKnown() bool

type MinTLSVersionID

type MinTLSVersionID string

ID of the zone setting.

const (
	MinTLSVersionIDMinTLSVersion MinTLSVersionID = "min_tls_version"
)

func (MinTLSVersionID) IsKnown

func (r MinTLSVersionID) IsKnown() bool

type MinTLSVersionParam

type MinTLSVersionParam struct {
	// ID of the zone setting.
	ID param.Field[MinTLSVersionID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[MinTLSVersionValue] `json:"value,required"`
}

Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.

func (MinTLSVersionParam) MarshalJSON

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

type MinTLSVersionValue

type MinTLSVersionValue string

Current value of the zone setting.

const (
	MinTLSVersionValue1_0 MinTLSVersionValue = "1.0"
	MinTLSVersionValue1_1 MinTLSVersionValue = "1.1"
	MinTLSVersionValue1_2 MinTLSVersionValue = "1.2"
	MinTLSVersionValue1_3 MinTLSVersionValue = "1.3"
)

func (MinTLSVersionValue) IsKnown

func (r MinTLSVersionValue) IsKnown() bool

type Mirage

type Mirage struct {
	// Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can
	// accelerate loading of image-heavy websites on very slow mobile connections and
	// HTTP/1.
	ID MirageID `json:"id"`
	// The status of Mirage.
	Value MirageValue `json:"value"`
	JSON  mirageJSON  `json:"-"`
}

func (Mirage) ImplementsPageRulesPageRuleAction

func (r Mirage) ImplementsPageRulesPageRuleAction()

func (*Mirage) UnmarshalJSON

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

type MirageID

type MirageID string

Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can accelerate loading of image-heavy websites on very slow mobile connections and HTTP/1.

const (
	MirageIDMirage MirageID = "mirage"
)

func (MirageID) IsKnown

func (r MirageID) IsKnown() bool

type MirageParam

type MirageParam struct {
	// Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can
	// accelerate loading of image-heavy websites on very slow mobile connections and
	// HTTP/1.
	ID param.Field[MirageID] `json:"id"`
	// The status of Mirage.
	Value param.Field[MirageValue] `json:"value"`
}

func (MirageParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r MirageParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (MirageParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r MirageParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (MirageParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r MirageParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (MirageParam) MarshalJSON

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

type MirageValue

type MirageValue string

The status of Mirage.

const (
	MirageValueOn  MirageValue = "on"
	MirageValueOff MirageValue = "off"
)

func (MirageValue) IsKnown

func (r MirageValue) IsKnown() bool

type NEL

type NEL struct {
	// Zone setting identifier.
	ID NELID `json:"id,required"`
	// Current value of the zone setting.
	Value NELValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable NELEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	JSON       nelJSON   `json:"-"`
}

Enable Network Error Logging reporting on your zone. (Beta)

func (*NEL) UnmarshalJSON

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

type NELEditable

type NELEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	NELEditableTrue  NELEditable = true
	NELEditableFalse NELEditable = false
)

func (NELEditable) IsKnown

func (r NELEditable) IsKnown() bool

type NELID

type NELID string

Zone setting identifier.

const (
	NELIDNEL NELID = "nel"
)

func (NELID) IsKnown

func (r NELID) IsKnown() bool

type NELParam

type NELParam struct {
	// Zone setting identifier.
	ID param.Field[NELID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[NELValueParam] `json:"value,required"`
}

Enable Network Error Logging reporting on your zone. (Beta)

func (NELParam) MarshalJSON

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

type NELValue

type NELValue struct {
	Enabled bool         `json:"enabled"`
	JSON    nelValueJSON `json:"-"`
}

Current value of the zone setting.

func (*NELValue) UnmarshalJSON

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

type NELValueParam

type NELValueParam struct {
	Enabled param.Field[bool] `json:"enabled"`
}

Current value of the zone setting.

func (NELValueParam) MarshalJSON

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

type OpportunisticEncryption

type OpportunisticEncryption struct {
	// Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted
	// TLS channel. It's not a substitute for HTTPS, but provides additional security
	// for otherwise vulnerable requests.
	ID OpportunisticEncryptionID `json:"id"`
	// The status of Opportunistic Encryption.
	Value OpportunisticEncryptionValue `json:"value"`
	JSON  opportunisticEncryptionJSON  `json:"-"`
}

func (OpportunisticEncryption) ImplementsPageRulesPageRuleAction

func (r OpportunisticEncryption) ImplementsPageRulesPageRuleAction()

func (*OpportunisticEncryption) UnmarshalJSON

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

type OpportunisticEncryptionID

type OpportunisticEncryptionID string

Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted TLS channel. It's not a substitute for HTTPS, but provides additional security for otherwise vulnerable requests.

const (
	OpportunisticEncryptionIDOpportunisticEncryption OpportunisticEncryptionID = "opportunistic_encryption"
)

func (OpportunisticEncryptionID) IsKnown

func (r OpportunisticEncryptionID) IsKnown() bool

type OpportunisticEncryptionParam

type OpportunisticEncryptionParam struct {
	// Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted
	// TLS channel. It's not a substitute for HTTPS, but provides additional security
	// for otherwise vulnerable requests.
	ID param.Field[OpportunisticEncryptionID] `json:"id"`
	// The status of Opportunistic Encryption.
	Value param.Field[OpportunisticEncryptionValue] `json:"value"`
}

func (OpportunisticEncryptionParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r OpportunisticEncryptionParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (OpportunisticEncryptionParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r OpportunisticEncryptionParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (OpportunisticEncryptionParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r OpportunisticEncryptionParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (OpportunisticEncryptionParam) MarshalJSON

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

type OpportunisticEncryptionValue

type OpportunisticEncryptionValue string

The status of Opportunistic Encryption.

const (
	OpportunisticEncryptionValueOn  OpportunisticEncryptionValue = "on"
	OpportunisticEncryptionValueOff OpportunisticEncryptionValue = "off"
)

func (OpportunisticEncryptionValue) IsKnown

func (r OpportunisticEncryptionValue) IsKnown() bool

type OpportunisticOnion

type OpportunisticOnion struct {
	// ID of the zone setting.
	ID OpportunisticOnionID `json:"id,required"`
	// Current value of the zone setting.
	Value OpportunisticOnionValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable OpportunisticOnionEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time              `json:"modified_on,nullable" format:"date-time"`
	JSON       opportunisticOnionJSON `json:"-"`
}

Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.

func (*OpportunisticOnion) UnmarshalJSON

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

type OpportunisticOnionEditable

type OpportunisticOnionEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	OpportunisticOnionEditableTrue  OpportunisticOnionEditable = true
	OpportunisticOnionEditableFalse OpportunisticOnionEditable = false
)

func (OpportunisticOnionEditable) IsKnown

func (r OpportunisticOnionEditable) IsKnown() bool

type OpportunisticOnionID

type OpportunisticOnionID string

ID of the zone setting.

const (
	OpportunisticOnionIDOpportunisticOnion OpportunisticOnionID = "opportunistic_onion"
)

func (OpportunisticOnionID) IsKnown

func (r OpportunisticOnionID) IsKnown() bool

type OpportunisticOnionParam

type OpportunisticOnionParam struct {
	// ID of the zone setting.
	ID param.Field[OpportunisticOnionID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[OpportunisticOnionValue] `json:"value,required"`
}

Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.

func (OpportunisticOnionParam) MarshalJSON

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

type OpportunisticOnionValue

type OpportunisticOnionValue string

Current value of the zone setting.

const (
	OpportunisticOnionValueOn  OpportunisticOnionValue = "on"
	OpportunisticOnionValueOff OpportunisticOnionValue = "off"
)

func (OpportunisticOnionValue) IsKnown

func (r OpportunisticOnionValue) IsKnown() bool

type OrangeToOrange

type OrangeToOrange struct {
	// ID of the zone setting.
	ID OrangeToOrangeID `json:"id,required"`
	// Current value of the zone setting.
	Value OrangeToOrangeValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable OrangeToOrangeEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time          `json:"modified_on,nullable" format:"date-time"`
	JSON       orangeToOrangeJSON `json:"-"`
}

Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.

func (*OrangeToOrange) UnmarshalJSON

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

type OrangeToOrangeEditable

type OrangeToOrangeEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	OrangeToOrangeEditableTrue  OrangeToOrangeEditable = true
	OrangeToOrangeEditableFalse OrangeToOrangeEditable = false
)

func (OrangeToOrangeEditable) IsKnown

func (r OrangeToOrangeEditable) IsKnown() bool

type OrangeToOrangeID

type OrangeToOrangeID string

ID of the zone setting.

const (
	OrangeToOrangeIDOrangeToOrange OrangeToOrangeID = "orange_to_orange"
)

func (OrangeToOrangeID) IsKnown

func (r OrangeToOrangeID) IsKnown() bool

type OrangeToOrangeParam

type OrangeToOrangeParam struct {
	// ID of the zone setting.
	ID param.Field[OrangeToOrangeID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[OrangeToOrangeValue] `json:"value,required"`
}

Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.

func (OrangeToOrangeParam) MarshalJSON

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

type OrangeToOrangeValue

type OrangeToOrangeValue string

Current value of the zone setting.

const (
	OrangeToOrangeValueOn  OrangeToOrangeValue = "on"
	OrangeToOrangeValueOff OrangeToOrangeValue = "off"
)

func (OrangeToOrangeValue) IsKnown

func (r OrangeToOrangeValue) IsKnown() bool

type OriginErrorPagePassThru

type OriginErrorPagePassThru struct {
	// Turn on or off Cloudflare error pages generated from issues sent from the origin
	// server. If enabled, this setting triggers error pages issued by the origin.
	ID OriginErrorPagePassThruID `json:"id"`
	// The status of Origin Error Page Passthru.
	Value OriginErrorPagePassThruValue `json:"value"`
	JSON  originErrorPagePassThruJSON  `json:"-"`
}

func (OriginErrorPagePassThru) ImplementsPageRulesPageRuleAction

func (r OriginErrorPagePassThru) ImplementsPageRulesPageRuleAction()

func (*OriginErrorPagePassThru) UnmarshalJSON

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

type OriginErrorPagePassThruID

type OriginErrorPagePassThruID string

Turn on or off Cloudflare error pages generated from issues sent from the origin server. If enabled, this setting triggers error pages issued by the origin.

const (
	OriginErrorPagePassThruIDOriginErrorPagePassThru OriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

func (OriginErrorPagePassThruID) IsKnown

func (r OriginErrorPagePassThruID) IsKnown() bool

type OriginErrorPagePassThruParam

type OriginErrorPagePassThruParam struct {
	// Turn on or off Cloudflare error pages generated from issues sent from the origin
	// server. If enabled, this setting triggers error pages issued by the origin.
	ID param.Field[OriginErrorPagePassThruID] `json:"id"`
	// The status of Origin Error Page Passthru.
	Value param.Field[OriginErrorPagePassThruValue] `json:"value"`
}

func (OriginErrorPagePassThruParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r OriginErrorPagePassThruParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (OriginErrorPagePassThruParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r OriginErrorPagePassThruParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (OriginErrorPagePassThruParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r OriginErrorPagePassThruParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (OriginErrorPagePassThruParam) MarshalJSON

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

type OriginErrorPagePassThruValue

type OriginErrorPagePassThruValue string

The status of Origin Error Page Passthru.

const (
	OriginErrorPagePassThruValueOn  OriginErrorPagePassThruValue = "on"
	OriginErrorPagePassThruValueOff OriginErrorPagePassThruValue = "off"
)

func (OriginErrorPagePassThruValue) IsKnown

func (r OriginErrorPagePassThruValue) IsKnown() bool

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 PlanGetParams

type PlanGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type PlanGetResponseEnvelope

type PlanGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   AvailableRatePlan     `json:"result,required"`
	// Whether the API call was successful
	Success PlanGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    planGetResponseEnvelopeJSON    `json:"-"`
}

func (*PlanGetResponseEnvelope) UnmarshalJSON

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

type PlanGetResponseEnvelopeSuccess

type PlanGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	PlanGetResponseEnvelopeSuccessTrue PlanGetResponseEnvelopeSuccess = true
)

func (PlanGetResponseEnvelopeSuccess) IsKnown

type PlanListParams

type PlanListParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type PlanService

type PlanService struct {
	Options []option.RequestOption
}

PlanService 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 NewPlanService method instead.

func NewPlanService

func NewPlanService(opts ...option.RequestOption) (r *PlanService)

NewPlanService 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 (*PlanService) Get

func (r *PlanService) Get(ctx context.Context, planIdentifier string, query PlanGetParams, opts ...option.RequestOption) (res *AvailableRatePlan, err error)

Details of the available plan that the zone can subscribe to.

func (*PlanService) List

Lists available plans the zone can subscribe to.

func (*PlanService) ListAutoPaging

Lists available plans the zone can subscribe to.

type Polish

type Polish struct {
	// Apply options from the Polish feature of the Cloudflare Speed app.
	ID PolishID `json:"id"`
	// The level of Polish you want applied to your origin.
	Value PolishValue `json:"value"`
	JSON  polishJSON  `json:"-"`
}

func (Polish) ImplementsPageRulesPageRuleAction

func (r Polish) ImplementsPageRulesPageRuleAction()

func (*Polish) UnmarshalJSON

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

type PolishID

type PolishID string

Apply options from the Polish feature of the Cloudflare Speed app.

const (
	PolishIDPolish PolishID = "polish"
)

func (PolishID) IsKnown

func (r PolishID) IsKnown() bool

type PolishParam

type PolishParam struct {
	// Apply options from the Polish feature of the Cloudflare Speed app.
	ID param.Field[PolishID] `json:"id"`
	// The level of Polish you want applied to your origin.
	Value param.Field[PolishValue] `json:"value"`
}

func (PolishParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r PolishParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (PolishParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r PolishParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (PolishParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r PolishParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (PolishParam) MarshalJSON

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

type PolishValue

type PolishValue string

The level of Polish you want applied to your origin.

const (
	PolishValueOff      PolishValue = "off"
	PolishValueLossless PolishValue = "lossless"
	PolishValueLossy    PolishValue = "lossy"
)

func (PolishValue) IsKnown

func (r PolishValue) IsKnown() bool

type PrefetchPreload

type PrefetchPreload struct {
	// ID of the zone setting.
	ID PrefetchPreloadID `json:"id,required"`
	// Current value of the zone setting.
	Value PrefetchPreloadValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable PrefetchPreloadEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time           `json:"modified_on,nullable" format:"date-time"`
	JSON       prefetchPreloadJSON `json:"-"`
}

Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.

func (*PrefetchPreload) UnmarshalJSON

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

type PrefetchPreloadEditable

type PrefetchPreloadEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	PrefetchPreloadEditableTrue  PrefetchPreloadEditable = true
	PrefetchPreloadEditableFalse PrefetchPreloadEditable = false
)

func (PrefetchPreloadEditable) IsKnown

func (r PrefetchPreloadEditable) IsKnown() bool

type PrefetchPreloadID

type PrefetchPreloadID string

ID of the zone setting.

const (
	PrefetchPreloadIDPrefetchPreload PrefetchPreloadID = "prefetch_preload"
)

func (PrefetchPreloadID) IsKnown

func (r PrefetchPreloadID) IsKnown() bool

type PrefetchPreloadParam

type PrefetchPreloadParam struct {
	// ID of the zone setting.
	ID param.Field[PrefetchPreloadID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[PrefetchPreloadValue] `json:"value,required"`
}

Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.

func (PrefetchPreloadParam) MarshalJSON

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

type PrefetchPreloadValue

type PrefetchPreloadValue string

Current value of the zone setting.

const (
	PrefetchPreloadValueOn  PrefetchPreloadValue = "on"
	PrefetchPreloadValueOff PrefetchPreloadValue = "off"
)

func (PrefetchPreloadValue) IsKnown

func (r PrefetchPreloadValue) IsKnown() bool

type ProxyReadTimeout

type ProxyReadTimeout struct {
	// ID of the zone setting.
	ID ProxyReadTimeoutID `json:"id,required"`
	// Current value of the zone setting.
	Value float64 `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ProxyReadTimeoutEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time            `json:"modified_on,nullable" format:"date-time"`
	JSON       proxyReadTimeoutJSON `json:"-"`
}

Maximum time between two read operations from origin.

func (*ProxyReadTimeout) UnmarshalJSON

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

type ProxyReadTimeoutEditable

type ProxyReadTimeoutEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	ProxyReadTimeoutEditableTrue  ProxyReadTimeoutEditable = true
	ProxyReadTimeoutEditableFalse ProxyReadTimeoutEditable = false
)

func (ProxyReadTimeoutEditable) IsKnown

func (r ProxyReadTimeoutEditable) IsKnown() bool

type ProxyReadTimeoutID

type ProxyReadTimeoutID string

ID of the zone setting.

const (
	ProxyReadTimeoutIDProxyReadTimeout ProxyReadTimeoutID = "proxy_read_timeout"
)

func (ProxyReadTimeoutID) IsKnown

func (r ProxyReadTimeoutID) IsKnown() bool

type ProxyReadTimeoutParam

type ProxyReadTimeoutParam struct {
	// ID of the zone setting.
	ID param.Field[ProxyReadTimeoutID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[float64] `json:"value,required"`
}

Maximum time between two read operations from origin.

func (ProxyReadTimeoutParam) MarshalJSON

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

type PseudoIPV4

type PseudoIPV4 struct {
	// Value of the Pseudo IPv4 setting.
	ID PseudoIPV4ID `json:"id,required"`
	// Current value of the zone setting.
	Value PseudoIPV4Value `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable PseudoIPV4Editable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time      `json:"modified_on,nullable" format:"date-time"`
	JSON       pseudoIPV4JSON `json:"-"`
}

The value set for the Pseudo IPv4 setting.

func (*PseudoIPV4) UnmarshalJSON

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

type PseudoIPV4Editable

type PseudoIPV4Editable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	PseudoIPV4EditableTrue  PseudoIPV4Editable = true
	PseudoIPV4EditableFalse PseudoIPV4Editable = false
)

func (PseudoIPV4Editable) IsKnown

func (r PseudoIPV4Editable) IsKnown() bool

type PseudoIPV4ID

type PseudoIPV4ID string

Value of the Pseudo IPv4 setting.

const (
	PseudoIPV4IDPseudoIPV4 PseudoIPV4ID = "pseudo_ipv4"
)

func (PseudoIPV4ID) IsKnown

func (r PseudoIPV4ID) IsKnown() bool

type PseudoIPV4Param

type PseudoIPV4Param struct {
	// Value of the Pseudo IPv4 setting.
	ID param.Field[PseudoIPV4ID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[PseudoIPV4Value] `json:"value,required"`
}

The value set for the Pseudo IPv4 setting.

func (PseudoIPV4Param) MarshalJSON

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

type PseudoIPV4Value

type PseudoIPV4Value string

Current value of the zone setting.

const (
	PseudoIPV4ValueOff             PseudoIPV4Value = "off"
	PseudoIPV4ValueAddHeader       PseudoIPV4Value = "add_header"
	PseudoIPV4ValueOverwriteHeader PseudoIPV4Value = "overwrite_header"
)

func (PseudoIPV4Value) IsKnown

func (r PseudoIPV4Value) IsKnown() bool

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanGetParams

type RatePlanGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type RatePlanGetResponse

type RatePlanGetResponse struct {
	// Plan identifier tag.
	ID string `json:"id"`
	// Array of available components values for the plan.
	Components []RatePlanGetResponseComponent `json:"components"`
	// The monetary unit in which pricing information is displayed.
	Currency string `json:"currency"`
	// The duration of the plan subscription.
	Duration float64 `json:"duration"`
	// The frequency at which you will be billed for this plan.
	Frequency RatePlanGetResponseFrequency `json:"frequency"`
	// The plan name.
	Name string                  `json:"name"`
	JSON ratePlanGetResponseJSON `json:"-"`
}

func (*RatePlanGetResponse) UnmarshalJSON

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

type RatePlanGetResponseComponent

type RatePlanGetResponseComponent struct {
	// The default amount allocated.
	Default float64 `json:"default"`
	// The unique component.
	Name RatePlanGetResponseComponentsName `json:"name"`
	// The unit price of the addon.
	UnitPrice float64                          `json:"unit_price"`
	JSON      ratePlanGetResponseComponentJSON `json:"-"`
}

func (*RatePlanGetResponseComponent) UnmarshalJSON

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

type RatePlanGetResponseComponentsName

type RatePlanGetResponseComponentsName string

The unique component.

const (
	RatePlanGetResponseComponentsNameZones                       RatePlanGetResponseComponentsName = "zones"
	RatePlanGetResponseComponentsNamePageRules                   RatePlanGetResponseComponentsName = "page_rules"
	RatePlanGetResponseComponentsNameDedicatedCertificates       RatePlanGetResponseComponentsName = "dedicated_certificates"
	RatePlanGetResponseComponentsNameDedicatedCertificatesCustom RatePlanGetResponseComponentsName = "dedicated_certificates_custom"
)

func (RatePlanGetResponseComponentsName) IsKnown

type RatePlanGetResponseEnvelope

type RatePlanGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   []RatePlanGetResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    RatePlanGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo RatePlanGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       ratePlanGetResponseEnvelopeJSON       `json:"-"`
}

func (*RatePlanGetResponseEnvelope) UnmarshalJSON

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

type RatePlanGetResponseEnvelopeResultInfo

type RatePlanGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                   `json:"total_count"`
	JSON       ratePlanGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*RatePlanGetResponseEnvelopeResultInfo) UnmarshalJSON

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

type RatePlanGetResponseEnvelopeSuccess

type RatePlanGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	RatePlanGetResponseEnvelopeSuccessTrue RatePlanGetResponseEnvelopeSuccess = true
)

func (RatePlanGetResponseEnvelopeSuccess) IsKnown

type RatePlanGetResponseFrequency

type RatePlanGetResponseFrequency string

The frequency at which you will be billed for this plan.

const (
	RatePlanGetResponseFrequencyWeekly    RatePlanGetResponseFrequency = "weekly"
	RatePlanGetResponseFrequencyMonthly   RatePlanGetResponseFrequency = "monthly"
	RatePlanGetResponseFrequencyQuarterly RatePlanGetResponseFrequency = "quarterly"
	RatePlanGetResponseFrequencyYearly    RatePlanGetResponseFrequency = "yearly"
)

func (RatePlanGetResponseFrequency) IsKnown

func (r RatePlanGetResponseFrequency) IsKnown() bool

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanService

type RatePlanService struct {
	Options []option.RequestOption
}

RatePlanService 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 NewRatePlanService method instead.

func NewRatePlanService

func NewRatePlanService(opts ...option.RequestOption) (r *RatePlanService)

NewRatePlanService 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 (*RatePlanService) Get

Lists all rate plans the zone can subscribe to.

type ResponseBuffering

type ResponseBuffering struct {
	// Turn on or off whether Cloudflare should wait for an entire file from the origin
	// server before forwarding it to the site visitor. By default, Cloudflare sends
	// packets to the client as they arrive from the origin server.
	ID ResponseBufferingID `json:"id"`
	// The status of Response Buffering
	Value ResponseBufferingValue `json:"value"`
	JSON  responseBufferingJSON  `json:"-"`
}

func (ResponseBuffering) ImplementsPageRulesPageRuleAction

func (r ResponseBuffering) ImplementsPageRulesPageRuleAction()

func (*ResponseBuffering) UnmarshalJSON

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

type ResponseBufferingID

type ResponseBufferingID string

Turn on or off whether Cloudflare should wait for an entire file from the origin server before forwarding it to the site visitor. By default, Cloudflare sends packets to the client as they arrive from the origin server.

const (
	ResponseBufferingIDResponseBuffering ResponseBufferingID = "response_buffering"
)

func (ResponseBufferingID) IsKnown

func (r ResponseBufferingID) IsKnown() bool

type ResponseBufferingParam

type ResponseBufferingParam struct {
	// Turn on or off whether Cloudflare should wait for an entire file from the origin
	// server before forwarding it to the site visitor. By default, Cloudflare sends
	// packets to the client as they arrive from the origin server.
	ID param.Field[ResponseBufferingID] `json:"id"`
	// The status of Response Buffering
	Value param.Field[ResponseBufferingValue] `json:"value"`
}

func (ResponseBufferingParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r ResponseBufferingParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (ResponseBufferingParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r ResponseBufferingParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (ResponseBufferingParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r ResponseBufferingParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (ResponseBufferingParam) MarshalJSON

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

type ResponseBufferingValue

type ResponseBufferingValue string

The status of Response Buffering

const (
	ResponseBufferingValueOn  ResponseBufferingValue = "on"
	ResponseBufferingValueOff ResponseBufferingValue = "off"
)

func (ResponseBufferingValue) IsKnown

func (r ResponseBufferingValue) IsKnown() bool

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type RocketLoader

type RocketLoader struct {
	// Turn on or off Rocket Loader in the Cloudflare Speed app.
	ID RocketLoaderID `json:"id"`
	// The status of Rocket Loader
	Value RocketLoaderValue `json:"value"`
	JSON  rocketLoaderJSON  `json:"-"`
}

func (RocketLoader) ImplementsPageRulesPageRuleAction

func (r RocketLoader) ImplementsPageRulesPageRuleAction()

func (*RocketLoader) UnmarshalJSON

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

type RocketLoaderID

type RocketLoaderID string

Turn on or off Rocket Loader in the Cloudflare Speed app.

const (
	RocketLoaderIDRocketLoader RocketLoaderID = "rocket_loader"
)

func (RocketLoaderID) IsKnown

func (r RocketLoaderID) IsKnown() bool

type RocketLoaderParam

type RocketLoaderParam struct {
	// Turn on or off Rocket Loader in the Cloudflare Speed app.
	ID param.Field[RocketLoaderID] `json:"id"`
	// The status of Rocket Loader
	Value param.Field[RocketLoaderValue] `json:"value"`
}

func (RocketLoaderParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r RocketLoaderParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (RocketLoaderParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r RocketLoaderParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (RocketLoaderParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r RocketLoaderParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (RocketLoaderParam) MarshalJSON

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

type RocketLoaderValue

type RocketLoaderValue string

The status of Rocket Loader

const (
	RocketLoaderValueOn  RocketLoaderValue = "on"
	RocketLoaderValueOff RocketLoaderValue = "off"
)

func (RocketLoaderValue) IsKnown

func (r RocketLoaderValue) IsKnown() bool

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 SSL

type SSL struct {
	// Control options for the SSL feature of the Edge Certificates tab in the
	// Cloudflare SSL/TLS app.
	ID SSLID `json:"id"`
	// The encryption mode that Cloudflare uses to connect to your origin server.
	Value SSLValue `json:"value"`
	JSON  sslJSON  `json:"-"`
}

func (SSL) ImplementsPageRulesPageRuleAction

func (r SSL) ImplementsPageRulesPageRuleAction()

func (*SSL) UnmarshalJSON

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

type SSLID

type SSLID string

Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.

const (
	SSLIDSSL SSLID = "ssl"
)

func (SSLID) IsKnown

func (r SSLID) IsKnown() bool

type SSLParam

type SSLParam struct {
	// Control options for the SSL feature of the Edge Certificates tab in the
	// Cloudflare SSL/TLS app.
	ID param.Field[SSLID] `json:"id"`
	// The encryption mode that Cloudflare uses to connect to your origin server.
	Value param.Field[SSLValue] `json:"value"`
}

func (SSLParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r SSLParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (SSLParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r SSLParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (SSLParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r SSLParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (SSLParam) MarshalJSON

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

type SSLRecommender

type SSLRecommender struct {
	// Enrollment value for SSL/TLS Recommender.
	ID SSLRecommenderID `json:"id"`
	// ssl-recommender enrollment setting.
	Enabled bool               `json:"enabled"`
	JSON    sslRecommenderJSON `json:"-"`
}

Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.

func (*SSLRecommender) UnmarshalJSON

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

type SSLRecommenderID

type SSLRecommenderID string

Enrollment value for SSL/TLS Recommender.

const (
	SSLRecommenderIDSSLRecommender SSLRecommenderID = "ssl_recommender"
)

func (SSLRecommenderID) IsKnown

func (r SSLRecommenderID) IsKnown() bool

type SSLRecommenderParam

type SSLRecommenderParam struct {
	// Enrollment value for SSL/TLS Recommender.
	ID param.Field[SSLRecommenderID] `json:"id"`
	// ssl-recommender enrollment setting.
	Enabled param.Field[bool] `json:"enabled"`
}

Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.

func (SSLRecommenderParam) MarshalJSON

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

type SSLValue

type SSLValue string

The encryption mode that Cloudflare uses to connect to your origin server.

const (
	SSLValueOff        SSLValue = "off"
	SSLValueFlexible   SSLValue = "flexible"
	SSLValueFull       SSLValue = "full"
	SSLValueStrict     SSLValue = "strict"
	SSLValueOriginPull SSLValue = "origin_pull"
)

func (SSLValue) IsKnown

func (r SSLValue) IsKnown() bool

type SecurityHeaders

type SecurityHeaders struct {
	// ID of the zone's security header.
	ID SecurityHeadersID `json:"id,required"`
	// Current value of the zone setting.
	Value SecurityHeadersValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SecurityHeadersEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time           `json:"modified_on,nullable" format:"date-time"`
	JSON       securityHeadersJSON `json:"-"`
}

Cloudflare security header for a zone.

func (*SecurityHeaders) UnmarshalJSON

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

type SecurityHeadersEditable

type SecurityHeadersEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SecurityHeadersEditableTrue  SecurityHeadersEditable = true
	SecurityHeadersEditableFalse SecurityHeadersEditable = false
)

func (SecurityHeadersEditable) IsKnown

func (r SecurityHeadersEditable) IsKnown() bool

type SecurityHeadersID

type SecurityHeadersID string

ID of the zone's security header.

const (
	SecurityHeadersIDSecurityHeader SecurityHeadersID = "security_header"
)

func (SecurityHeadersID) IsKnown

func (r SecurityHeadersID) IsKnown() bool

type SecurityHeadersParam

type SecurityHeadersParam struct {
	// ID of the zone's security header.
	ID param.Field[SecurityHeadersID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SecurityHeadersValueParam] `json:"value,required"`
}

Cloudflare security header for a zone.

func (SecurityHeadersParam) MarshalJSON

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

type SecurityHeadersValue

type SecurityHeadersValue struct {
	// Strict Transport Security.
	StrictTransportSecurity SecurityHeadersValueStrictTransportSecurity `json:"strict_transport_security"`
	JSON                    securityHeadersValueJSON                    `json:"-"`
}

Current value of the zone setting.

func (*SecurityHeadersValue) UnmarshalJSON

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

type SecurityHeadersValueParam

type SecurityHeadersValueParam struct {
	// Strict Transport Security.
	StrictTransportSecurity param.Field[SecurityHeadersValueStrictTransportSecurityParam] `json:"strict_transport_security"`
}

Current value of the zone setting.

func (SecurityHeadersValueParam) MarshalJSON

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

type SecurityHeadersValueStrictTransportSecurity

type SecurityHeadersValueStrictTransportSecurity struct {
	// Whether or not strict transport security is enabled.
	Enabled bool `json:"enabled"`
	// Include all subdomains for strict transport security.
	IncludeSubdomains bool `json:"include_subdomains"`
	// Max age in seconds of the strict transport security.
	MaxAge float64 `json:"max_age"`
	// Whether or not to include 'X-Content-Type-Options: nosniff' header.
	Nosniff bool `json:"nosniff"`
	// Enable automatic preload of the HSTS configuration.
	Preload bool                                            `json:"preload"`
	JSON    securityHeadersValueStrictTransportSecurityJSON `json:"-"`
}

Strict Transport Security.

func (*SecurityHeadersValueStrictTransportSecurity) UnmarshalJSON

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

type SecurityHeadersValueStrictTransportSecurityParam

type SecurityHeadersValueStrictTransportSecurityParam struct {
	// Whether or not strict transport security is enabled.
	Enabled param.Field[bool] `json:"enabled"`
	// Include all subdomains for strict transport security.
	IncludeSubdomains param.Field[bool] `json:"include_subdomains"`
	// Max age in seconds of the strict transport security.
	MaxAge param.Field[float64] `json:"max_age"`
	// Whether or not to include 'X-Content-Type-Options: nosniff' header.
	Nosniff param.Field[bool] `json:"nosniff"`
	// Enable automatic preload of the HSTS configuration.
	Preload param.Field[bool] `json:"preload"`
}

Strict Transport Security.

func (SecurityHeadersValueStrictTransportSecurityParam) MarshalJSON

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

type SecurityLevel

type SecurityLevel struct {
	// Control options for the **Security Level** feature from the **Security** app.
	ID    SecurityLevelID    `json:"id"`
	Value SecurityLevelValue `json:"value"`
	JSON  securityLevelJSON  `json:"-"`
}

func (SecurityLevel) ImplementsPageRulesPageRuleAction

func (r SecurityLevel) ImplementsPageRulesPageRuleAction()

func (*SecurityLevel) UnmarshalJSON

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

type SecurityLevelID

type SecurityLevelID string

Control options for the **Security Level** feature from the **Security** app.

const (
	SecurityLevelIDSecurityLevel SecurityLevelID = "security_level"
)

func (SecurityLevelID) IsKnown

func (r SecurityLevelID) IsKnown() bool

type SecurityLevelParam

type SecurityLevelParam struct {
	// Control options for the **Security Level** feature from the **Security** app.
	ID    param.Field[SecurityLevelID]    `json:"id"`
	Value param.Field[SecurityLevelValue] `json:"value"`
}

func (SecurityLevelParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r SecurityLevelParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (SecurityLevelParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r SecurityLevelParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (SecurityLevelParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r SecurityLevelParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (SecurityLevelParam) MarshalJSON

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

type SecurityLevelValue

type SecurityLevelValue string
const (
	SecurityLevelValueOff            SecurityLevelValue = "off"
	SecurityLevelValueEssentiallyOff SecurityLevelValue = "essentially_off"
	SecurityLevelValueLow            SecurityLevelValue = "low"
	SecurityLevelValueMedium         SecurityLevelValue = "medium"
	SecurityLevelValueHigh           SecurityLevelValue = "high"
	SecurityLevelValueUnderAttack    SecurityLevelValue = "under_attack"
)

func (SecurityLevelValue) IsKnown

func (r SecurityLevelValue) IsKnown() bool

type ServerSideExcludes

type ServerSideExcludes struct {
	// ID of the zone setting.
	ID ServerSideExcludesID `json:"id,required"`
	// Current value of the zone setting.
	Value ServerSideExcludesValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ServerSideExcludesEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time              `json:"modified_on,nullable" format:"date-time"`
	JSON       serverSideExcludesJSON `json:"-"`
}

If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).

func (*ServerSideExcludes) UnmarshalJSON

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

type ServerSideExcludesEditable

type ServerSideExcludesEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	ServerSideExcludesEditableTrue  ServerSideExcludesEditable = true
	ServerSideExcludesEditableFalse ServerSideExcludesEditable = false
)

func (ServerSideExcludesEditable) IsKnown

func (r ServerSideExcludesEditable) IsKnown() bool

type ServerSideExcludesID

type ServerSideExcludesID string

ID of the zone setting.

const (
	ServerSideExcludesIDServerSideExclude ServerSideExcludesID = "server_side_exclude"
)

func (ServerSideExcludesID) IsKnown

func (r ServerSideExcludesID) IsKnown() bool

type ServerSideExcludesParam

type ServerSideExcludesParam struct {
	// ID of the zone setting.
	ID param.Field[ServerSideExcludesID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ServerSideExcludesValue] `json:"value,required"`
}

If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).

func (ServerSideExcludesParam) MarshalJSON

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

type ServerSideExcludesValue

type ServerSideExcludesValue string

Current value of the zone setting.

const (
	ServerSideExcludesValueOn  ServerSideExcludesValue = "on"
	ServerSideExcludesValueOff ServerSideExcludesValue = "off"
)

func (ServerSideExcludesValue) IsKnown

func (r ServerSideExcludesValue) IsKnown() bool

type SettingEditParams

type SettingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// 0-RTT session resumption enabled for this zone.
	Body SettingEditParamsBodyUnion `json:"body,required"`
}

func (SettingEditParams) MarshalJSON

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

type SettingEditParamsBody

type SettingEditParamsBody struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyID] `json:"id"`
	// ssl-recommender enrollment setting.
	Enabled param.Field[bool]        `json:"enabled"`
	Value   param.Field[interface{}] `json:"value"`
}

0-RTT session resumption enabled for this zone.

func (SettingEditParamsBody) MarshalJSON

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

type SettingEditParamsBodyEditable

type SettingEditParamsBodyEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyEditableTrue  SettingEditParamsBodyEditable = true
	SettingEditParamsBodyEditableFalse SettingEditParamsBodyEditable = false
)

func (SettingEditParamsBodyEditable) IsKnown

func (r SettingEditParamsBodyEditable) IsKnown() bool

type SettingEditParamsBodyID

type SettingEditParamsBodyID string

ID of the zone setting.

const (
	SettingEditParamsBodyID0rtt                          SettingEditParamsBodyID = "0rtt"
	SettingEditParamsBodyIDAdvancedDDoS                  SettingEditParamsBodyID = "advanced_ddos"
	SettingEditParamsBodyIDAlwaysOnline                  SettingEditParamsBodyID = "always_online"
	SettingEditParamsBodyIDAlwaysUseHTTPS                SettingEditParamsBodyID = "always_use_https"
	SettingEditParamsBodyIDAutomaticHTTPSRewrites        SettingEditParamsBodyID = "automatic_https_rewrites"
	SettingEditParamsBodyIDBrotli                        SettingEditParamsBodyID = "brotli"
	SettingEditParamsBodyIDBrowserCacheTTL               SettingEditParamsBodyID = "browser_cache_ttl"
	SettingEditParamsBodyIDBrowserCheck                  SettingEditParamsBodyID = "browser_check"
	SettingEditParamsBodyIDCacheLevel                    SettingEditParamsBodyID = "cache_level"
	SettingEditParamsBodyIDChallengeTTL                  SettingEditParamsBodyID = "challenge_ttl"
	SettingEditParamsBodyIDCiphers                       SettingEditParamsBodyID = "ciphers"
	SettingEditParamsBodyIDCNAMEFlattening               SettingEditParamsBodyID = "cname_flattening"
	SettingEditParamsBodyIDDevelopmentMode               SettingEditParamsBodyID = "development_mode"
	SettingEditParamsBodyIDEarlyHints                    SettingEditParamsBodyID = "early_hints"
	SettingEditParamsBodyIDEdgeCacheTTL                  SettingEditParamsBodyID = "edge_cache_ttl"
	SettingEditParamsBodyIDEmailObfuscation              SettingEditParamsBodyID = "email_obfuscation"
	SettingEditParamsBodyIDH2Prioritization              SettingEditParamsBodyID = "h2_prioritization"
	SettingEditParamsBodyIDHotlinkProtection             SettingEditParamsBodyID = "hotlink_protection"
	SettingEditParamsBodyIDHTTP2                         SettingEditParamsBodyID = "http2"
	SettingEditParamsBodyIDHTTP3                         SettingEditParamsBodyID = "http3"
	SettingEditParamsBodyIDImageResizing                 SettingEditParamsBodyID = "image_resizing"
	SettingEditParamsBodyIDIPGeolocation                 SettingEditParamsBodyID = "ip_geolocation"
	SettingEditParamsBodyIDIPV6                          SettingEditParamsBodyID = "ipv6"
	SettingEditParamsBodyIDMaxUpload                     SettingEditParamsBodyID = "max_upload"
	SettingEditParamsBodyIDMinTLSVersion                 SettingEditParamsBodyID = "min_tls_version"
	SettingEditParamsBodyIDMirage                        SettingEditParamsBodyID = "mirage"
	SettingEditParamsBodyIDNEL                           SettingEditParamsBodyID = "nel"
	SettingEditParamsBodyIDOpportunisticEncryption       SettingEditParamsBodyID = "opportunistic_encryption"
	SettingEditParamsBodyIDOpportunisticOnion            SettingEditParamsBodyID = "opportunistic_onion"
	SettingEditParamsBodyIDOrangeToOrange                SettingEditParamsBodyID = "orange_to_orange"
	SettingEditParamsBodyIDOriginErrorPagePassThru       SettingEditParamsBodyID = "origin_error_page_pass_thru"
	SettingEditParamsBodyIDPolish                        SettingEditParamsBodyID = "polish"
	SettingEditParamsBodyIDPrefetchPreload               SettingEditParamsBodyID = "prefetch_preload"
	SettingEditParamsBodyIDProxyReadTimeout              SettingEditParamsBodyID = "proxy_read_timeout"
	SettingEditParamsBodyIDPseudoIPV4                    SettingEditParamsBodyID = "pseudo_ipv4"
	SettingEditParamsBodyIDReplaceInsecureJS             SettingEditParamsBodyID = "replace_insecure_js"
	SettingEditParamsBodyIDResponseBuffering             SettingEditParamsBodyID = "response_buffering"
	SettingEditParamsBodyIDRocketLoader                  SettingEditParamsBodyID = "rocket_loader"
	SettingEditParamsBodyIDAutomaticPlatformOptimization SettingEditParamsBodyID = "automatic_platform_optimization"
	SettingEditParamsBodyIDSecurityHeader                SettingEditParamsBodyID = "security_header"
	SettingEditParamsBodyIDSecurityLevel                 SettingEditParamsBodyID = "security_level"
	SettingEditParamsBodyIDServerSideExclude             SettingEditParamsBodyID = "server_side_exclude"
	SettingEditParamsBodyIDSha1Support                   SettingEditParamsBodyID = "sha1_support"
	SettingEditParamsBodyIDSortQueryStringForCache       SettingEditParamsBodyID = "sort_query_string_for_cache"
	SettingEditParamsBodyIDSSL                           SettingEditParamsBodyID = "ssl"
	SettingEditParamsBodyIDSSLRecommender                SettingEditParamsBodyID = "ssl_recommender"
	SettingEditParamsBodyIDTLS1_2Only                    SettingEditParamsBodyID = "tls_1_2_only"
	SettingEditParamsBodyIDTLS1_3                        SettingEditParamsBodyID = "tls_1_3"
	SettingEditParamsBodyIDTLSClientAuth                 SettingEditParamsBodyID = "tls_client_auth"
	SettingEditParamsBodyIDTrueClientIPHeader            SettingEditParamsBodyID = "true_client_ip_header"
	SettingEditParamsBodyIDWAF                           SettingEditParamsBodyID = "waf"
	SettingEditParamsBodyIDWebP                          SettingEditParamsBodyID = "webp"
	SettingEditParamsBodyIDWebsockets                    SettingEditParamsBodyID = "websockets"
)

func (SettingEditParamsBodyID) IsKnown

func (r SettingEditParamsBodyID) IsKnown() bool

type SettingEditParamsBodyUnion

type SettingEditParamsBodyUnion interface {
	// contains filtered or unexported methods
}

0-RTT session resumption enabled for this zone.

Satisfied by zones.ZeroRTTParam, zones.AdvancedDDoSParam, zones.AlwaysOnlineParam, zones.SettingEditParamsBodyZonesSchemasAlwaysUseHTTPS, zones.SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewrites, zones.BrotliParam, zones.SettingEditParamsBodyZonesSchemasBrowserCacheTTL, zones.SettingEditParamsBodyZonesSchemasBrowserCheck, zones.SettingEditParamsBodyZonesSchemasCacheLevel, zones.ChallengeTTLParam, zones.CiphersParam, zones.SettingEditParamsBodyZonesCNAMEFlattening, zones.DevelopmentModeParam, zones.EarlyHintsParam, zones.SettingEditParamsBodyZonesSchemasEdgeCacheTTL, zones.SettingEditParamsBodyZonesSchemasEmailObfuscation, zones.H2PrioritizationParam, zones.HotlinkProtectionParam, zones.HTTP2Param, zones.HTTP3Param, zones.ImageResizingParam, zones.SettingEditParamsBodyZonesSchemasIPGeolocation, zones.IPV6Param, zones.SettingEditParamsBodyZonesMaxUpload, zones.MinTLSVersionParam, zones.SettingEditParamsBodyZonesSchemasMirage, zones.NELParam, zones.SettingEditParamsBodyZonesSchemasOpportunisticEncryption, zones.OpportunisticOnionParam, zones.OrangeToOrangeParam, zones.SettingEditParamsBodyZonesSchemasOriginErrorPagePassThru, zones.SettingEditParamsBodyZonesSchemasPolish, zones.PrefetchPreloadParam, zones.ProxyReadTimeoutParam, zones.PseudoIPV4Param, zones.SettingEditParamsBodyZonesReplaceInsecureJS, zones.SettingEditParamsBodyZonesSchemasResponseBuffering, zones.SettingEditParamsBodyZonesSchemasRocketLoader, zones.SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeadersParam, zones.SettingEditParamsBodyZonesSchemasSecurityLevel, zones.ServerSideExcludesParam, zones.SettingEditParamsBodyZonesSha1Support, zones.SettingEditParamsBodyZonesSchemasSortQueryStringForCache, zones.SettingEditParamsBodyZonesSchemasSSL, zones.SSLRecommenderParam, zones.SettingEditParamsBodyZonesTLS1_2Only, zones.TLS1_3Param, zones.TLSClientAuthParam, zones.SettingEditParamsBodyZonesSchemasTrueClientIPHeader, zones.SettingEditParamsBodyZonesSchemasWAF, zones.WebPParam, zones.WebsocketParam, SettingEditParamsBody.

type SettingEditParamsBodyZonesCNAMEFlattening

type SettingEditParamsBodyZonesCNAMEFlattening struct {
	// How to flatten the cname destination.
	ID param.Field[SettingEditParamsBodyZonesCNAMEFlatteningID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesCNAMEFlatteningValue] `json:"value,required"`
}

Whether or not cname flattening is on.

func (SettingEditParamsBodyZonesCNAMEFlattening) MarshalJSON

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

type SettingEditParamsBodyZonesCNAMEFlatteningEditable

type SettingEditParamsBodyZonesCNAMEFlatteningEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesCNAMEFlatteningEditableTrue  SettingEditParamsBodyZonesCNAMEFlatteningEditable = true
	SettingEditParamsBodyZonesCNAMEFlatteningEditableFalse SettingEditParamsBodyZonesCNAMEFlatteningEditable = false
)

func (SettingEditParamsBodyZonesCNAMEFlatteningEditable) IsKnown

type SettingEditParamsBodyZonesCNAMEFlatteningID

type SettingEditParamsBodyZonesCNAMEFlatteningID string

How to flatten the cname destination.

const (
	SettingEditParamsBodyZonesCNAMEFlatteningIDCNAMEFlattening SettingEditParamsBodyZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingEditParamsBodyZonesCNAMEFlatteningID) IsKnown

type SettingEditParamsBodyZonesCNAMEFlatteningValue

type SettingEditParamsBodyZonesCNAMEFlatteningValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesCNAMEFlatteningValueFlattenAtRoot SettingEditParamsBodyZonesCNAMEFlatteningValue = "flatten_at_root"
	SettingEditParamsBodyZonesCNAMEFlatteningValueFlattenAll    SettingEditParamsBodyZonesCNAMEFlatteningValue = "flatten_all"
)

func (SettingEditParamsBodyZonesCNAMEFlatteningValue) IsKnown

type SettingEditParamsBodyZonesMaxUpload

type SettingEditParamsBodyZonesMaxUpload struct {
	// identifier of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesMaxUploadID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesMaxUploadValue] `json:"value,required"`
}

Maximum size of an allowable upload.

func (SettingEditParamsBodyZonesMaxUpload) MarshalJSON

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

type SettingEditParamsBodyZonesMaxUploadEditable

type SettingEditParamsBodyZonesMaxUploadEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesMaxUploadEditableTrue  SettingEditParamsBodyZonesMaxUploadEditable = true
	SettingEditParamsBodyZonesMaxUploadEditableFalse SettingEditParamsBodyZonesMaxUploadEditable = false
)

func (SettingEditParamsBodyZonesMaxUploadEditable) IsKnown

type SettingEditParamsBodyZonesMaxUploadID

type SettingEditParamsBodyZonesMaxUploadID string

identifier of the zone setting.

const (
	SettingEditParamsBodyZonesMaxUploadIDMaxUpload SettingEditParamsBodyZonesMaxUploadID = "max_upload"
)

func (SettingEditParamsBodyZonesMaxUploadID) IsKnown

type SettingEditParamsBodyZonesMaxUploadValue

type SettingEditParamsBodyZonesMaxUploadValue float64

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesMaxUploadValue100 SettingEditParamsBodyZonesMaxUploadValue = 100
	SettingEditParamsBodyZonesMaxUploadValue200 SettingEditParamsBodyZonesMaxUploadValue = 200
	SettingEditParamsBodyZonesMaxUploadValue500 SettingEditParamsBodyZonesMaxUploadValue = 500
)

func (SettingEditParamsBodyZonesMaxUploadValue) IsKnown

type SettingEditParamsBodyZonesReplaceInsecureJS

type SettingEditParamsBodyZonesReplaceInsecureJS struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesReplaceInsecureJSID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesReplaceInsecureJSValue] `json:"value,required"`
}

Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io.

func (SettingEditParamsBodyZonesReplaceInsecureJS) MarshalJSON

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

type SettingEditParamsBodyZonesReplaceInsecureJSEditable

type SettingEditParamsBodyZonesReplaceInsecureJSEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesReplaceInsecureJSEditableTrue  SettingEditParamsBodyZonesReplaceInsecureJSEditable = true
	SettingEditParamsBodyZonesReplaceInsecureJSEditableFalse SettingEditParamsBodyZonesReplaceInsecureJSEditable = false
)

func (SettingEditParamsBodyZonesReplaceInsecureJSEditable) IsKnown

type SettingEditParamsBodyZonesReplaceInsecureJSID

type SettingEditParamsBodyZonesReplaceInsecureJSID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesReplaceInsecureJSIDReplaceInsecureJS SettingEditParamsBodyZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingEditParamsBodyZonesReplaceInsecureJSID) IsKnown

type SettingEditParamsBodyZonesReplaceInsecureJSValue

type SettingEditParamsBodyZonesReplaceInsecureJSValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesReplaceInsecureJSValueOn  SettingEditParamsBodyZonesReplaceInsecureJSValue = "on"
	SettingEditParamsBodyZonesReplaceInsecureJSValueOff SettingEditParamsBodyZonesReplaceInsecureJSValue = "off"
)

func (SettingEditParamsBodyZonesReplaceInsecureJSValue) IsKnown

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPS

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPS struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValue] `json:"value,required"`
}

Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.

func (SettingEditParamsBodyZonesSchemasAlwaysUseHTTPS) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSEditable

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSEditableTrue  SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSEditable = true
	SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSEditableFalse SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSEditable = false
)

func (SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSEditable) IsKnown

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSID

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSIDAlwaysUseHTTPS SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSID = "always_use_https"
)

func (SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSID) IsKnown

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValue

type SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValueOn  SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValue = "on"
	SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValueOff SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValue = "off"
)

func (SettingEditParamsBodyZonesSchemasAlwaysUseHTTPSValue) IsKnown

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewrites

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewrites struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValue] `json:"value,required"`
}

Enable the Automatic HTTPS Rewrites feature for this zone.

func (SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewrites) MarshalJSON

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesEditable

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesEditableTrue  SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesEditable = true
	SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesEditableFalse SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesEditable = false
)

func (SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesEditable) IsKnown

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesID

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesIDAutomaticHTTPSRewrites SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

func (SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesID) IsKnown

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValue

type SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValueOn  SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValue = "on"
	SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValueOff SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValue = "off"
)

func (SettingEditParamsBodyZonesSchemasAutomaticHTTPSRewritesValue) IsKnown

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimization

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimization struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[AutomaticPlatformOptimizationParam] `json:"value,required"`
}

[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.

func (SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimization) MarshalJSON

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditableTrue  SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable = true
	SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditableFalse SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable = false
)

func (SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID) IsKnown

type SettingEditParamsBodyZonesSchemasBrowserCacheTTL

type SettingEditParamsBodyZonesSchemasBrowserCacheTTL struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasBrowserCacheTTLID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue] `json:"value,required"`
}

Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).

func (SettingEditParamsBodyZonesSchemasBrowserCacheTTL) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasBrowserCacheTTLEditable

type SettingEditParamsBodyZonesSchemasBrowserCacheTTLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLEditableTrue  SettingEditParamsBodyZonesSchemasBrowserCacheTTLEditable = true
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLEditableFalse SettingEditParamsBodyZonesSchemasBrowserCacheTTLEditable = false
)

func (SettingEditParamsBodyZonesSchemasBrowserCacheTTLEditable) IsKnown

type SettingEditParamsBodyZonesSchemasBrowserCacheTTLID

type SettingEditParamsBodyZonesSchemasBrowserCacheTTLID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLIDBrowserCacheTTL SettingEditParamsBodyZonesSchemasBrowserCacheTTLID = "browser_cache_ttl"
)

func (SettingEditParamsBodyZonesSchemasBrowserCacheTTLID) IsKnown

type SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue

type SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue float64

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue0        SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 0
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue30       SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 30
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue60       SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 60
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue120      SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 120
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue300      SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 300
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue1200     SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 1200
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue1800     SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 1800
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue3600     SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 3600
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue7200     SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 7200
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue10800    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 10800
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue14400    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 14400
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue18000    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 18000
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue28800    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 28800
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue43200    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 43200
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue57600    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 57600
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue72000    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 72000
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue86400    SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 86400
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue172800   SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 172800
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue259200   SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 259200
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue345600   SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 345600
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue432000   SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 432000
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue691200   SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 691200
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue1382400  SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 1382400
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue2073600  SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 2073600
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue2678400  SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 2678400
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue5356800  SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 5356800
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue16070400 SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 16070400
	SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue31536000 SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue = 31536000
)

func (SettingEditParamsBodyZonesSchemasBrowserCacheTTLValue) IsKnown

type SettingEditParamsBodyZonesSchemasBrowserCheck

type SettingEditParamsBodyZonesSchemasBrowserCheck struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasBrowserCheckID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasBrowserCheckValue] `json:"value,required"`
}

Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).

func (SettingEditParamsBodyZonesSchemasBrowserCheck) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasBrowserCheckEditable

type SettingEditParamsBodyZonesSchemasBrowserCheckEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasBrowserCheckEditableTrue  SettingEditParamsBodyZonesSchemasBrowserCheckEditable = true
	SettingEditParamsBodyZonesSchemasBrowserCheckEditableFalse SettingEditParamsBodyZonesSchemasBrowserCheckEditable = false
)

func (SettingEditParamsBodyZonesSchemasBrowserCheckEditable) IsKnown

type SettingEditParamsBodyZonesSchemasBrowserCheckID

type SettingEditParamsBodyZonesSchemasBrowserCheckID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasBrowserCheckIDBrowserCheck SettingEditParamsBodyZonesSchemasBrowserCheckID = "browser_check"
)

func (SettingEditParamsBodyZonesSchemasBrowserCheckID) IsKnown

type SettingEditParamsBodyZonesSchemasBrowserCheckValue

type SettingEditParamsBodyZonesSchemasBrowserCheckValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasBrowserCheckValueOn  SettingEditParamsBodyZonesSchemasBrowserCheckValue = "on"
	SettingEditParamsBodyZonesSchemasBrowserCheckValueOff SettingEditParamsBodyZonesSchemasBrowserCheckValue = "off"
)

func (SettingEditParamsBodyZonesSchemasBrowserCheckValue) IsKnown

type SettingEditParamsBodyZonesSchemasCacheLevel

type SettingEditParamsBodyZonesSchemasCacheLevel struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasCacheLevelID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasCacheLevelValue] `json:"value,required"`
}

Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).

func (SettingEditParamsBodyZonesSchemasCacheLevel) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasCacheLevelEditable

type SettingEditParamsBodyZonesSchemasCacheLevelEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasCacheLevelEditableTrue  SettingEditParamsBodyZonesSchemasCacheLevelEditable = true
	SettingEditParamsBodyZonesSchemasCacheLevelEditableFalse SettingEditParamsBodyZonesSchemasCacheLevelEditable = false
)

func (SettingEditParamsBodyZonesSchemasCacheLevelEditable) IsKnown

type SettingEditParamsBodyZonesSchemasCacheLevelID

type SettingEditParamsBodyZonesSchemasCacheLevelID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasCacheLevelIDCacheLevel SettingEditParamsBodyZonesSchemasCacheLevelID = "cache_level"
)

func (SettingEditParamsBodyZonesSchemasCacheLevelID) IsKnown

type SettingEditParamsBodyZonesSchemasCacheLevelValue

type SettingEditParamsBodyZonesSchemasCacheLevelValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasCacheLevelValueAggressive SettingEditParamsBodyZonesSchemasCacheLevelValue = "aggressive"
	SettingEditParamsBodyZonesSchemasCacheLevelValueBasic      SettingEditParamsBodyZonesSchemasCacheLevelValue = "basic"
	SettingEditParamsBodyZonesSchemasCacheLevelValueSimplified SettingEditParamsBodyZonesSchemasCacheLevelValue = "simplified"
)

func (SettingEditParamsBodyZonesSchemasCacheLevelValue) IsKnown

type SettingEditParamsBodyZonesSchemasEdgeCacheTTL

type SettingEditParamsBodyZonesSchemasEdgeCacheTTL struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasEdgeCacheTTLID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue] `json:"value,required"`
}

Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.

func (SettingEditParamsBodyZonesSchemasEdgeCacheTTL) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasEdgeCacheTTLEditable

type SettingEditParamsBodyZonesSchemasEdgeCacheTTLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLEditableTrue  SettingEditParamsBodyZonesSchemasEdgeCacheTTLEditable = true
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLEditableFalse SettingEditParamsBodyZonesSchemasEdgeCacheTTLEditable = false
)

func (SettingEditParamsBodyZonesSchemasEdgeCacheTTLEditable) IsKnown

type SettingEditParamsBodyZonesSchemasEdgeCacheTTLID

type SettingEditParamsBodyZonesSchemasEdgeCacheTTLID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLIDEdgeCacheTTL SettingEditParamsBodyZonesSchemasEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingEditParamsBodyZonesSchemasEdgeCacheTTLID) IsKnown

type SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue

type SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue float64

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue30     SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 30
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue60     SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 60
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue300    SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 300
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue1200   SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 1200
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue1800   SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 1800
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue3600   SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 3600
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue7200   SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 7200
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue10800  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 10800
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue14400  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 14400
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue18000  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 18000
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue28800  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 28800
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue43200  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 43200
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue57600  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 57600
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue72000  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 72000
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue86400  SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 86400
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue172800 SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 172800
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue259200 SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 259200
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue345600 SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 345600
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue432000 SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 432000
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue518400 SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 518400
	SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue604800 SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue = 604800
)

func (SettingEditParamsBodyZonesSchemasEdgeCacheTTLValue) IsKnown

type SettingEditParamsBodyZonesSchemasEmailObfuscation

type SettingEditParamsBodyZonesSchemasEmailObfuscation struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasEmailObfuscationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasEmailObfuscationValue] `json:"value,required"`
}

Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).

func (SettingEditParamsBodyZonesSchemasEmailObfuscation) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasEmailObfuscationEditable

type SettingEditParamsBodyZonesSchemasEmailObfuscationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasEmailObfuscationEditableTrue  SettingEditParamsBodyZonesSchemasEmailObfuscationEditable = true
	SettingEditParamsBodyZonesSchemasEmailObfuscationEditableFalse SettingEditParamsBodyZonesSchemasEmailObfuscationEditable = false
)

func (SettingEditParamsBodyZonesSchemasEmailObfuscationEditable) IsKnown

type SettingEditParamsBodyZonesSchemasEmailObfuscationID

type SettingEditParamsBodyZonesSchemasEmailObfuscationID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasEmailObfuscationIDEmailObfuscation SettingEditParamsBodyZonesSchemasEmailObfuscationID = "email_obfuscation"
)

func (SettingEditParamsBodyZonesSchemasEmailObfuscationID) IsKnown

type SettingEditParamsBodyZonesSchemasEmailObfuscationValue

type SettingEditParamsBodyZonesSchemasEmailObfuscationValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasEmailObfuscationValueOn  SettingEditParamsBodyZonesSchemasEmailObfuscationValue = "on"
	SettingEditParamsBodyZonesSchemasEmailObfuscationValueOff SettingEditParamsBodyZonesSchemasEmailObfuscationValue = "off"
)

func (SettingEditParamsBodyZonesSchemasEmailObfuscationValue) IsKnown

type SettingEditParamsBodyZonesSchemasIPGeolocation

type SettingEditParamsBodyZonesSchemasIPGeolocation struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasIPGeolocationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasIPGeolocationValue] `json:"value,required"`
}

Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).

func (SettingEditParamsBodyZonesSchemasIPGeolocation) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasIPGeolocationEditable

type SettingEditParamsBodyZonesSchemasIPGeolocationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasIPGeolocationEditableTrue  SettingEditParamsBodyZonesSchemasIPGeolocationEditable = true
	SettingEditParamsBodyZonesSchemasIPGeolocationEditableFalse SettingEditParamsBodyZonesSchemasIPGeolocationEditable = false
)

func (SettingEditParamsBodyZonesSchemasIPGeolocationEditable) IsKnown

type SettingEditParamsBodyZonesSchemasIPGeolocationID

type SettingEditParamsBodyZonesSchemasIPGeolocationID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasIPGeolocationIDIPGeolocation SettingEditParamsBodyZonesSchemasIPGeolocationID = "ip_geolocation"
)

func (SettingEditParamsBodyZonesSchemasIPGeolocationID) IsKnown

type SettingEditParamsBodyZonesSchemasIPGeolocationValue

type SettingEditParamsBodyZonesSchemasIPGeolocationValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasIPGeolocationValueOn  SettingEditParamsBodyZonesSchemasIPGeolocationValue = "on"
	SettingEditParamsBodyZonesSchemasIPGeolocationValueOff SettingEditParamsBodyZonesSchemasIPGeolocationValue = "off"
)

func (SettingEditParamsBodyZonesSchemasIPGeolocationValue) IsKnown

type SettingEditParamsBodyZonesSchemasMirage

type SettingEditParamsBodyZonesSchemasMirage struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasMirageID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasMirageValue] `json:"value,required"`
}

Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.

func (SettingEditParamsBodyZonesSchemasMirage) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasMirageEditable

type SettingEditParamsBodyZonesSchemasMirageEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasMirageEditableTrue  SettingEditParamsBodyZonesSchemasMirageEditable = true
	SettingEditParamsBodyZonesSchemasMirageEditableFalse SettingEditParamsBodyZonesSchemasMirageEditable = false
)

func (SettingEditParamsBodyZonesSchemasMirageEditable) IsKnown

type SettingEditParamsBodyZonesSchemasMirageID

type SettingEditParamsBodyZonesSchemasMirageID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasMirageIDMirage SettingEditParamsBodyZonesSchemasMirageID = "mirage"
)

func (SettingEditParamsBodyZonesSchemasMirageID) IsKnown

type SettingEditParamsBodyZonesSchemasMirageValue

type SettingEditParamsBodyZonesSchemasMirageValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasMirageValueOn  SettingEditParamsBodyZonesSchemasMirageValue = "on"
	SettingEditParamsBodyZonesSchemasMirageValueOff SettingEditParamsBodyZonesSchemasMirageValue = "off"
)

func (SettingEditParamsBodyZonesSchemasMirageValue) IsKnown

type SettingEditParamsBodyZonesSchemasOpportunisticEncryption

type SettingEditParamsBodyZonesSchemasOpportunisticEncryption struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasOpportunisticEncryptionID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValue] `json:"value,required"`
}

Enables the Opportunistic Encryption feature for a zone.

func (SettingEditParamsBodyZonesSchemasOpportunisticEncryption) MarshalJSON

type SettingEditParamsBodyZonesSchemasOpportunisticEncryptionEditable

type SettingEditParamsBodyZonesSchemasOpportunisticEncryptionEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasOpportunisticEncryptionEditableTrue  SettingEditParamsBodyZonesSchemasOpportunisticEncryptionEditable = true
	SettingEditParamsBodyZonesSchemasOpportunisticEncryptionEditableFalse SettingEditParamsBodyZonesSchemasOpportunisticEncryptionEditable = false
)

func (SettingEditParamsBodyZonesSchemasOpportunisticEncryptionEditable) IsKnown

type SettingEditParamsBodyZonesSchemasOpportunisticEncryptionID

type SettingEditParamsBodyZonesSchemasOpportunisticEncryptionID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasOpportunisticEncryptionIDOpportunisticEncryption SettingEditParamsBodyZonesSchemasOpportunisticEncryptionID = "opportunistic_encryption"
)

func (SettingEditParamsBodyZonesSchemasOpportunisticEncryptionID) IsKnown

type SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValue

type SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValueOn  SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValue = "on"
	SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValueOff SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValue = "off"
)

func (SettingEditParamsBodyZonesSchemasOpportunisticEncryptionValue) IsKnown

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThru

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThru struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValue] `json:"value,required"`
}

Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.

func (SettingEditParamsBodyZonesSchemasOriginErrorPagePassThru) MarshalJSON

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruEditable

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruEditableTrue  SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruEditable = true
	SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruEditableFalse SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruEditable = false
)

func (SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruEditable) IsKnown

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruID

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruIDOriginErrorPagePassThru SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

func (SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruID) IsKnown

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValue

type SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValueOn  SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValue = "on"
	SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValueOff SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValue = "off"
)

func (SettingEditParamsBodyZonesSchemasOriginErrorPagePassThruValue) IsKnown

type SettingEditParamsBodyZonesSchemasPolish

type SettingEditParamsBodyZonesSchemasPolish struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasPolishID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasPolishValue] `json:"value,required"`
}

Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.

func (SettingEditParamsBodyZonesSchemasPolish) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasPolishEditable

type SettingEditParamsBodyZonesSchemasPolishEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasPolishEditableTrue  SettingEditParamsBodyZonesSchemasPolishEditable = true
	SettingEditParamsBodyZonesSchemasPolishEditableFalse SettingEditParamsBodyZonesSchemasPolishEditable = false
)

func (SettingEditParamsBodyZonesSchemasPolishEditable) IsKnown

type SettingEditParamsBodyZonesSchemasPolishID

type SettingEditParamsBodyZonesSchemasPolishID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasPolishIDPolish SettingEditParamsBodyZonesSchemasPolishID = "polish"
)

func (SettingEditParamsBodyZonesSchemasPolishID) IsKnown

type SettingEditParamsBodyZonesSchemasPolishValue

type SettingEditParamsBodyZonesSchemasPolishValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasPolishValueOff      SettingEditParamsBodyZonesSchemasPolishValue = "off"
	SettingEditParamsBodyZonesSchemasPolishValueLossless SettingEditParamsBodyZonesSchemasPolishValue = "lossless"
	SettingEditParamsBodyZonesSchemasPolishValueLossy    SettingEditParamsBodyZonesSchemasPolishValue = "lossy"
)

func (SettingEditParamsBodyZonesSchemasPolishValue) IsKnown

type SettingEditParamsBodyZonesSchemasResponseBuffering

type SettingEditParamsBodyZonesSchemasResponseBuffering struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasResponseBufferingID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasResponseBufferingValue] `json:"value,required"`
}

Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.

func (SettingEditParamsBodyZonesSchemasResponseBuffering) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasResponseBufferingEditable

type SettingEditParamsBodyZonesSchemasResponseBufferingEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasResponseBufferingEditableTrue  SettingEditParamsBodyZonesSchemasResponseBufferingEditable = true
	SettingEditParamsBodyZonesSchemasResponseBufferingEditableFalse SettingEditParamsBodyZonesSchemasResponseBufferingEditable = false
)

func (SettingEditParamsBodyZonesSchemasResponseBufferingEditable) IsKnown

type SettingEditParamsBodyZonesSchemasResponseBufferingID

type SettingEditParamsBodyZonesSchemasResponseBufferingID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasResponseBufferingIDResponseBuffering SettingEditParamsBodyZonesSchemasResponseBufferingID = "response_buffering"
)

func (SettingEditParamsBodyZonesSchemasResponseBufferingID) IsKnown

type SettingEditParamsBodyZonesSchemasResponseBufferingValue

type SettingEditParamsBodyZonesSchemasResponseBufferingValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasResponseBufferingValueOn  SettingEditParamsBodyZonesSchemasResponseBufferingValue = "on"
	SettingEditParamsBodyZonesSchemasResponseBufferingValueOff SettingEditParamsBodyZonesSchemasResponseBufferingValue = "off"
)

func (SettingEditParamsBodyZonesSchemasResponseBufferingValue) IsKnown

type SettingEditParamsBodyZonesSchemasRocketLoader

type SettingEditParamsBodyZonesSchemasRocketLoader struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasRocketLoaderID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasRocketLoaderValue] `json:"value,required"`
}

Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.

func (SettingEditParamsBodyZonesSchemasRocketLoader) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasRocketLoaderEditable

type SettingEditParamsBodyZonesSchemasRocketLoaderEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasRocketLoaderEditableTrue  SettingEditParamsBodyZonesSchemasRocketLoaderEditable = true
	SettingEditParamsBodyZonesSchemasRocketLoaderEditableFalse SettingEditParamsBodyZonesSchemasRocketLoaderEditable = false
)

func (SettingEditParamsBodyZonesSchemasRocketLoaderEditable) IsKnown

type SettingEditParamsBodyZonesSchemasRocketLoaderID

type SettingEditParamsBodyZonesSchemasRocketLoaderID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasRocketLoaderIDRocketLoader SettingEditParamsBodyZonesSchemasRocketLoaderID = "rocket_loader"
)

func (SettingEditParamsBodyZonesSchemasRocketLoaderID) IsKnown

type SettingEditParamsBodyZonesSchemasRocketLoaderValue

type SettingEditParamsBodyZonesSchemasRocketLoaderValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasRocketLoaderValueOn  SettingEditParamsBodyZonesSchemasRocketLoaderValue = "on"
	SettingEditParamsBodyZonesSchemasRocketLoaderValueOff SettingEditParamsBodyZonesSchemasRocketLoaderValue = "off"
)

func (SettingEditParamsBodyZonesSchemasRocketLoaderValue) IsKnown

type SettingEditParamsBodyZonesSchemasSSL

type SettingEditParamsBodyZonesSchemasSSL struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasSSLID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasSSLValue] `json:"value,required"`
}

SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).

func (SettingEditParamsBodyZonesSchemasSSL) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasSSLEditable

type SettingEditParamsBodyZonesSchemasSSLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasSSLEditableTrue  SettingEditParamsBodyZonesSchemasSSLEditable = true
	SettingEditParamsBodyZonesSchemasSSLEditableFalse SettingEditParamsBodyZonesSchemasSSLEditable = false
)

func (SettingEditParamsBodyZonesSchemasSSLEditable) IsKnown

type SettingEditParamsBodyZonesSchemasSSLID

type SettingEditParamsBodyZonesSchemasSSLID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasSSLIDSSL SettingEditParamsBodyZonesSchemasSSLID = "ssl"
)

func (SettingEditParamsBodyZonesSchemasSSLID) IsKnown

type SettingEditParamsBodyZonesSchemasSSLValue

type SettingEditParamsBodyZonesSchemasSSLValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasSSLValueOff      SettingEditParamsBodyZonesSchemasSSLValue = "off"
	SettingEditParamsBodyZonesSchemasSSLValueFlexible SettingEditParamsBodyZonesSchemasSSLValue = "flexible"
	SettingEditParamsBodyZonesSchemasSSLValueFull     SettingEditParamsBodyZonesSchemasSSLValue = "full"
	SettingEditParamsBodyZonesSchemasSSLValueStrict   SettingEditParamsBodyZonesSchemasSSLValue = "strict"
)

func (SettingEditParamsBodyZonesSchemasSSLValue) IsKnown

type SettingEditParamsBodyZonesSchemasSecurityLevel

type SettingEditParamsBodyZonesSchemasSecurityLevel struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasSecurityLevelID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasSecurityLevelValue] `json:"value,required"`
}

Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).

func (SettingEditParamsBodyZonesSchemasSecurityLevel) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasSecurityLevelEditable

type SettingEditParamsBodyZonesSchemasSecurityLevelEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasSecurityLevelEditableTrue  SettingEditParamsBodyZonesSchemasSecurityLevelEditable = true
	SettingEditParamsBodyZonesSchemasSecurityLevelEditableFalse SettingEditParamsBodyZonesSchemasSecurityLevelEditable = false
)

func (SettingEditParamsBodyZonesSchemasSecurityLevelEditable) IsKnown

type SettingEditParamsBodyZonesSchemasSecurityLevelID

type SettingEditParamsBodyZonesSchemasSecurityLevelID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasSecurityLevelIDSecurityLevel SettingEditParamsBodyZonesSchemasSecurityLevelID = "security_level"
)

func (SettingEditParamsBodyZonesSchemasSecurityLevelID) IsKnown

type SettingEditParamsBodyZonesSchemasSecurityLevelValue

type SettingEditParamsBodyZonesSchemasSecurityLevelValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasSecurityLevelValueOff            SettingEditParamsBodyZonesSchemasSecurityLevelValue = "off"
	SettingEditParamsBodyZonesSchemasSecurityLevelValueEssentiallyOff SettingEditParamsBodyZonesSchemasSecurityLevelValue = "essentially_off"
	SettingEditParamsBodyZonesSchemasSecurityLevelValueLow            SettingEditParamsBodyZonesSchemasSecurityLevelValue = "low"
	SettingEditParamsBodyZonesSchemasSecurityLevelValueMedium         SettingEditParamsBodyZonesSchemasSecurityLevelValue = "medium"
	SettingEditParamsBodyZonesSchemasSecurityLevelValueHigh           SettingEditParamsBodyZonesSchemasSecurityLevelValue = "high"
	SettingEditParamsBodyZonesSchemasSecurityLevelValueUnderAttack    SettingEditParamsBodyZonesSchemasSecurityLevelValue = "under_attack"
)

func (SettingEditParamsBodyZonesSchemasSecurityLevelValue) IsKnown

type SettingEditParamsBodyZonesSchemasSortQueryStringForCache

type SettingEditParamsBodyZonesSchemasSortQueryStringForCache struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasSortQueryStringForCacheID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValue] `json:"value,required"`
}

Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.

func (SettingEditParamsBodyZonesSchemasSortQueryStringForCache) MarshalJSON

type SettingEditParamsBodyZonesSchemasSortQueryStringForCacheEditable

type SettingEditParamsBodyZonesSchemasSortQueryStringForCacheEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasSortQueryStringForCacheEditableTrue  SettingEditParamsBodyZonesSchemasSortQueryStringForCacheEditable = true
	SettingEditParamsBodyZonesSchemasSortQueryStringForCacheEditableFalse SettingEditParamsBodyZonesSchemasSortQueryStringForCacheEditable = false
)

func (SettingEditParamsBodyZonesSchemasSortQueryStringForCacheEditable) IsKnown

type SettingEditParamsBodyZonesSchemasSortQueryStringForCacheID

type SettingEditParamsBodyZonesSchemasSortQueryStringForCacheID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasSortQueryStringForCacheIDSortQueryStringForCache SettingEditParamsBodyZonesSchemasSortQueryStringForCacheID = "sort_query_string_for_cache"
)

func (SettingEditParamsBodyZonesSchemasSortQueryStringForCacheID) IsKnown

type SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValue

type SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValueOn  SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValue = "on"
	SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValueOff SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValue = "off"
)

func (SettingEditParamsBodyZonesSchemasSortQueryStringForCacheValue) IsKnown

type SettingEditParamsBodyZonesSchemasTrueClientIPHeader

type SettingEditParamsBodyZonesSchemasTrueClientIPHeader struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasTrueClientIPHeaderID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValue] `json:"value,required"`
}

Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.

func (SettingEditParamsBodyZonesSchemasTrueClientIPHeader) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasTrueClientIPHeaderEditable

type SettingEditParamsBodyZonesSchemasTrueClientIPHeaderEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasTrueClientIPHeaderEditableTrue  SettingEditParamsBodyZonesSchemasTrueClientIPHeaderEditable = true
	SettingEditParamsBodyZonesSchemasTrueClientIPHeaderEditableFalse SettingEditParamsBodyZonesSchemasTrueClientIPHeaderEditable = false
)

func (SettingEditParamsBodyZonesSchemasTrueClientIPHeaderEditable) IsKnown

type SettingEditParamsBodyZonesSchemasTrueClientIPHeaderID

type SettingEditParamsBodyZonesSchemasTrueClientIPHeaderID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasTrueClientIPHeaderIDTrueClientIPHeader SettingEditParamsBodyZonesSchemasTrueClientIPHeaderID = "true_client_ip_header"
)

func (SettingEditParamsBodyZonesSchemasTrueClientIPHeaderID) IsKnown

type SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValue

type SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValueOn  SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValue = "on"
	SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValueOff SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValue = "off"
)

func (SettingEditParamsBodyZonesSchemasTrueClientIPHeaderValue) IsKnown

type SettingEditParamsBodyZonesSchemasWAF

type SettingEditParamsBodyZonesSchemasWAF struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsBodyZonesSchemasWAFID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSchemasWAFValue] `json:"value,required"`
}

The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).

func (SettingEditParamsBodyZonesSchemasWAF) MarshalJSON

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

type SettingEditParamsBodyZonesSchemasWAFEditable

type SettingEditParamsBodyZonesSchemasWAFEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSchemasWAFEditableTrue  SettingEditParamsBodyZonesSchemasWAFEditable = true
	SettingEditParamsBodyZonesSchemasWAFEditableFalse SettingEditParamsBodyZonesSchemasWAFEditable = false
)

func (SettingEditParamsBodyZonesSchemasWAFEditable) IsKnown

type SettingEditParamsBodyZonesSchemasWAFID

type SettingEditParamsBodyZonesSchemasWAFID string

ID of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasWAFIDWAF SettingEditParamsBodyZonesSchemasWAFID = "waf"
)

func (SettingEditParamsBodyZonesSchemasWAFID) IsKnown

type SettingEditParamsBodyZonesSchemasWAFValue

type SettingEditParamsBodyZonesSchemasWAFValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSchemasWAFValueOn  SettingEditParamsBodyZonesSchemasWAFValue = "on"
	SettingEditParamsBodyZonesSchemasWAFValueOff SettingEditParamsBodyZonesSchemasWAFValue = "off"
)

func (SettingEditParamsBodyZonesSchemasWAFValue) IsKnown

type SettingEditParamsBodyZonesSha1Support

type SettingEditParamsBodyZonesSha1Support struct {
	// Zone setting identifier.
	ID param.Field[SettingEditParamsBodyZonesSha1SupportID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesSha1SupportValue] `json:"value,required"`
}

Allow SHA1 support.

func (SettingEditParamsBodyZonesSha1Support) MarshalJSON

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

type SettingEditParamsBodyZonesSha1SupportEditable

type SettingEditParamsBodyZonesSha1SupportEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesSha1SupportEditableTrue  SettingEditParamsBodyZonesSha1SupportEditable = true
	SettingEditParamsBodyZonesSha1SupportEditableFalse SettingEditParamsBodyZonesSha1SupportEditable = false
)

func (SettingEditParamsBodyZonesSha1SupportEditable) IsKnown

type SettingEditParamsBodyZonesSha1SupportID

type SettingEditParamsBodyZonesSha1SupportID string

Zone setting identifier.

const (
	SettingEditParamsBodyZonesSha1SupportIDSha1Support SettingEditParamsBodyZonesSha1SupportID = "sha1_support"
)

func (SettingEditParamsBodyZonesSha1SupportID) IsKnown

type SettingEditParamsBodyZonesSha1SupportValue

type SettingEditParamsBodyZonesSha1SupportValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesSha1SupportValueOff SettingEditParamsBodyZonesSha1SupportValue = "off"
	SettingEditParamsBodyZonesSha1SupportValueOn  SettingEditParamsBodyZonesSha1SupportValue = "on"
)

func (SettingEditParamsBodyZonesSha1SupportValue) IsKnown

type SettingEditParamsBodyZonesTLS1_2Only

type SettingEditParamsBodyZonesTLS1_2Only struct {
	// Zone setting identifier.
	ID param.Field[SettingEditParamsBodyZonesTLS1_2OnlyID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[SettingEditParamsBodyZonesTLS1_2OnlyValue] `json:"value,required"`
}

Only allows TLS1.2.

func (SettingEditParamsBodyZonesTLS1_2Only) MarshalJSON

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

type SettingEditParamsBodyZonesTLS1_2OnlyEditable

type SettingEditParamsBodyZonesTLS1_2OnlyEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditParamsBodyZonesTLS1_2OnlyEditableTrue  SettingEditParamsBodyZonesTLS1_2OnlyEditable = true
	SettingEditParamsBodyZonesTLS1_2OnlyEditableFalse SettingEditParamsBodyZonesTLS1_2OnlyEditable = false
)

func (SettingEditParamsBodyZonesTLS1_2OnlyEditable) IsKnown

type SettingEditParamsBodyZonesTLS1_2OnlyID

type SettingEditParamsBodyZonesTLS1_2OnlyID string

Zone setting identifier.

const (
	SettingEditParamsBodyZonesTLS1_2OnlyIDTLS1_2Only SettingEditParamsBodyZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingEditParamsBodyZonesTLS1_2OnlyID) IsKnown

type SettingEditParamsBodyZonesTLS1_2OnlyValue

type SettingEditParamsBodyZonesTLS1_2OnlyValue string

Current value of the zone setting.

const (
	SettingEditParamsBodyZonesTLS1_2OnlyValueOff SettingEditParamsBodyZonesTLS1_2OnlyValue = "off"
	SettingEditParamsBodyZonesTLS1_2OnlyValueOn  SettingEditParamsBodyZonesTLS1_2OnlyValue = "on"
)

func (SettingEditParamsBodyZonesTLS1_2OnlyValue) IsKnown

type SettingEditResponse

type SettingEditResponse struct {
	// ID of the zone setting.
	ID SettingEditResponseID `json:"id"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseEditable `json:"editable"`
	// ssl-recommender enrollment setting.
	Enabled bool `json:"enabled"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the zone setting. Notes: The interval (in seconds) from when
	// development mode expires (positive integer) or last expired (negative integer)
	// for the domain. If development mode has never been enabled, this value is false.
	TimeRemaining float64 `json:"time_remaining"`
	// This field can have the runtime type of [ZeroRTTValue], [AdvancedDDoSValue],
	// [AlwaysOnlineValue], [SettingEditResponseZonesSchemasAlwaysUseHTTPSValue],
	// [SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue], [BrotliValue],
	// [SettingEditResponseZonesSchemasBrowserCacheTTLValue],
	// [SettingEditResponseZonesSchemasBrowserCheckValue],
	// [SettingEditResponseZonesSchemasCacheLevelValue], [ChallengeTTLValue],
	// [[]string], [SettingEditResponseZonesCNAMEFlatteningValue],
	// [DevelopmentModeValue], [EarlyHintsValue],
	// [SettingEditResponseZonesSchemasEdgeCacheTTLValue],
	// [SettingEditResponseZonesSchemasEmailObfuscationValue], [H2PrioritizationValue],
	// [HotlinkProtectionValue], [HTTP2Value], [HTTP3Value], [ImageResizingValue],
	// [SettingEditResponseZonesSchemasIPGeolocationValue], [IPV6Value],
	// [SettingEditResponseZonesMaxUploadValue], [MinTLSVersionValue],
	// [SettingEditResponseZonesSchemasMirageValue], [NELValue],
	// [SettingEditResponseZonesSchemasOpportunisticEncryptionValue],
	// [OpportunisticOnionValue], [OrangeToOrangeValue],
	// [SettingEditResponseZonesSchemasOriginErrorPagePassThruValue],
	// [SettingEditResponseZonesSchemasPolishValue], [PrefetchPreloadValue], [float64],
	// [PseudoIPV4Value], [SettingEditResponseZonesReplaceInsecureJSValue],
	// [SettingEditResponseZonesSchemasResponseBufferingValue],
	// [SettingEditResponseZonesSchemasRocketLoaderValue],
	// [AutomaticPlatformOptimization], [SecurityHeadersValue],
	// [SettingEditResponseZonesSchemasSecurityLevelValue], [ServerSideExcludesValue],
	// [SettingEditResponseZonesSha1SupportValue],
	// [SettingEditResponseZonesSchemasSortQueryStringForCacheValue],
	// [SettingEditResponseZonesSchemasSSLValue],
	// [SettingEditResponseZonesTLS1_2OnlyValue], [TLS1_3Value], [TLSClientAuthValue],
	// [SettingEditResponseZonesSchemasTrueClientIPHeaderValue],
	// [SettingEditResponseZonesSchemasWAFValue], [WebPValue], [WebsocketValue].
	Value interface{}             `json:"value"`
	JSON  settingEditResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

0-RTT session resumption enabled for this zone.

func (SettingEditResponse) AsUnion

AsUnion returns a SettingEditResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.SettingEditResponseZonesSchemasAlwaysUseHTTPS, zones.SettingEditResponseZonesSchemasAutomaticHTTPSRewrites, zones.Brotli, zones.SettingEditResponseZonesSchemasBrowserCacheTTL, zones.SettingEditResponseZonesSchemasBrowserCheck, zones.SettingEditResponseZonesSchemasCacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingEditResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingEditResponseZonesSchemasEdgeCacheTTL, zones.SettingEditResponseZonesSchemasEmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.SettingEditResponseZonesSchemasIPGeolocation, zones.IPV6, zones.SettingEditResponseZonesMaxUpload, zones.MinTLSVersion, zones.SettingEditResponseZonesSchemasMirage, zones.NEL, zones.SettingEditResponseZonesSchemasOpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.SettingEditResponseZonesSchemasOriginErrorPagePassThru, zones.SettingEditResponseZonesSchemasPolish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingEditResponseZonesReplaceInsecureJS, zones.SettingEditResponseZonesSchemasResponseBuffering, zones.SettingEditResponseZonesSchemasRocketLoader, zones.SettingEditResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SettingEditResponseZonesSchemasSecurityLevel, zones.ServerSideExcludes, zones.SettingEditResponseZonesSha1Support, zones.SettingEditResponseZonesSchemasSortQueryStringForCache, zones.SettingEditResponseZonesSchemasSSL, zones.SSLRecommender, zones.SettingEditResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.SettingEditResponseZonesSchemasTrueClientIPHeader, zones.SettingEditResponseZonesSchemasWAF, zones.WebP, zones.Websocket.

func (*SettingEditResponse) UnmarshalJSON

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

type SettingEditResponseEditable

type SettingEditResponseEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseEditableTrue  SettingEditResponseEditable = true
	SettingEditResponseEditableFalse SettingEditResponseEditable = false
)

func (SettingEditResponseEditable) IsKnown

func (r SettingEditResponseEditable) IsKnown() bool

type SettingEditResponseEnvelope

type SettingEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// 0-RTT session resumption enabled for this zone.
	Result SettingEditResponse             `json:"result"`
	JSON   settingEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingEditResponseEnvelope) UnmarshalJSON

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

type SettingEditResponseID

type SettingEditResponseID string

ID of the zone setting.

const (
	SettingEditResponseID0rtt                          SettingEditResponseID = "0rtt"
	SettingEditResponseIDAdvancedDDoS                  SettingEditResponseID = "advanced_ddos"
	SettingEditResponseIDAlwaysOnline                  SettingEditResponseID = "always_online"
	SettingEditResponseIDAlwaysUseHTTPS                SettingEditResponseID = "always_use_https"
	SettingEditResponseIDAutomaticHTTPSRewrites        SettingEditResponseID = "automatic_https_rewrites"
	SettingEditResponseIDBrotli                        SettingEditResponseID = "brotli"
	SettingEditResponseIDBrowserCacheTTL               SettingEditResponseID = "browser_cache_ttl"
	SettingEditResponseIDBrowserCheck                  SettingEditResponseID = "browser_check"
	SettingEditResponseIDCacheLevel                    SettingEditResponseID = "cache_level"
	SettingEditResponseIDChallengeTTL                  SettingEditResponseID = "challenge_ttl"
	SettingEditResponseIDCiphers                       SettingEditResponseID = "ciphers"
	SettingEditResponseIDCNAMEFlattening               SettingEditResponseID = "cname_flattening"
	SettingEditResponseIDDevelopmentMode               SettingEditResponseID = "development_mode"
	SettingEditResponseIDEarlyHints                    SettingEditResponseID = "early_hints"
	SettingEditResponseIDEdgeCacheTTL                  SettingEditResponseID = "edge_cache_ttl"
	SettingEditResponseIDEmailObfuscation              SettingEditResponseID = "email_obfuscation"
	SettingEditResponseIDH2Prioritization              SettingEditResponseID = "h2_prioritization"
	SettingEditResponseIDHotlinkProtection             SettingEditResponseID = "hotlink_protection"
	SettingEditResponseIDHTTP2                         SettingEditResponseID = "http2"
	SettingEditResponseIDHTTP3                         SettingEditResponseID = "http3"
	SettingEditResponseIDImageResizing                 SettingEditResponseID = "image_resizing"
	SettingEditResponseIDIPGeolocation                 SettingEditResponseID = "ip_geolocation"
	SettingEditResponseIDIPV6                          SettingEditResponseID = "ipv6"
	SettingEditResponseIDMaxUpload                     SettingEditResponseID = "max_upload"
	SettingEditResponseIDMinTLSVersion                 SettingEditResponseID = "min_tls_version"
	SettingEditResponseIDMirage                        SettingEditResponseID = "mirage"
	SettingEditResponseIDNEL                           SettingEditResponseID = "nel"
	SettingEditResponseIDOpportunisticEncryption       SettingEditResponseID = "opportunistic_encryption"
	SettingEditResponseIDOpportunisticOnion            SettingEditResponseID = "opportunistic_onion"
	SettingEditResponseIDOrangeToOrange                SettingEditResponseID = "orange_to_orange"
	SettingEditResponseIDOriginErrorPagePassThru       SettingEditResponseID = "origin_error_page_pass_thru"
	SettingEditResponseIDPolish                        SettingEditResponseID = "polish"
	SettingEditResponseIDPrefetchPreload               SettingEditResponseID = "prefetch_preload"
	SettingEditResponseIDProxyReadTimeout              SettingEditResponseID = "proxy_read_timeout"
	SettingEditResponseIDPseudoIPV4                    SettingEditResponseID = "pseudo_ipv4"
	SettingEditResponseIDReplaceInsecureJS             SettingEditResponseID = "replace_insecure_js"
	SettingEditResponseIDResponseBuffering             SettingEditResponseID = "response_buffering"
	SettingEditResponseIDRocketLoader                  SettingEditResponseID = "rocket_loader"
	SettingEditResponseIDAutomaticPlatformOptimization SettingEditResponseID = "automatic_platform_optimization"
	SettingEditResponseIDSecurityHeader                SettingEditResponseID = "security_header"
	SettingEditResponseIDSecurityLevel                 SettingEditResponseID = "security_level"
	SettingEditResponseIDServerSideExclude             SettingEditResponseID = "server_side_exclude"
	SettingEditResponseIDSha1Support                   SettingEditResponseID = "sha1_support"
	SettingEditResponseIDSortQueryStringForCache       SettingEditResponseID = "sort_query_string_for_cache"
	SettingEditResponseIDSSL                           SettingEditResponseID = "ssl"
	SettingEditResponseIDSSLRecommender                SettingEditResponseID = "ssl_recommender"
	SettingEditResponseIDTLS1_2Only                    SettingEditResponseID = "tls_1_2_only"
	SettingEditResponseIDTLS1_3                        SettingEditResponseID = "tls_1_3"
	SettingEditResponseIDTLSClientAuth                 SettingEditResponseID = "tls_client_auth"
	SettingEditResponseIDTrueClientIPHeader            SettingEditResponseID = "true_client_ip_header"
	SettingEditResponseIDWAF                           SettingEditResponseID = "waf"
	SettingEditResponseIDWebP                          SettingEditResponseID = "webp"
	SettingEditResponseIDWebsockets                    SettingEditResponseID = "websockets"
)

func (SettingEditResponseID) IsKnown

func (r SettingEditResponseID) IsKnown() bool

type SettingEditResponseUnion

type SettingEditResponseUnion interface {
	// contains filtered or unexported methods
}

0-RTT session resumption enabled for this zone.

Union satisfied by zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.SettingEditResponseZonesSchemasAlwaysUseHTTPS, zones.SettingEditResponseZonesSchemasAutomaticHTTPSRewrites, zones.Brotli, zones.SettingEditResponseZonesSchemasBrowserCacheTTL, zones.SettingEditResponseZonesSchemasBrowserCheck, zones.SettingEditResponseZonesSchemasCacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingEditResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingEditResponseZonesSchemasEdgeCacheTTL, zones.SettingEditResponseZonesSchemasEmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.SettingEditResponseZonesSchemasIPGeolocation, zones.IPV6, zones.SettingEditResponseZonesMaxUpload, zones.MinTLSVersion, zones.SettingEditResponseZonesSchemasMirage, zones.NEL, zones.SettingEditResponseZonesSchemasOpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.SettingEditResponseZonesSchemasOriginErrorPagePassThru, zones.SettingEditResponseZonesSchemasPolish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingEditResponseZonesReplaceInsecureJS, zones.SettingEditResponseZonesSchemasResponseBuffering, zones.SettingEditResponseZonesSchemasRocketLoader, zones.SettingEditResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SettingEditResponseZonesSchemasSecurityLevel, zones.ServerSideExcludes, zones.SettingEditResponseZonesSha1Support, zones.SettingEditResponseZonesSchemasSortQueryStringForCache, zones.SettingEditResponseZonesSchemasSSL, zones.SSLRecommender, zones.SettingEditResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.SettingEditResponseZonesSchemasTrueClientIPHeader, zones.SettingEditResponseZonesSchemasWAF, zones.WebP or zones.Websocket.

type SettingEditResponseZonesCNAMEFlattening

type SettingEditResponseZonesCNAMEFlattening struct {
	// How to flatten the cname destination.
	ID SettingEditResponseZonesCNAMEFlatteningID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesCNAMEFlatteningValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesCNAMEFlatteningEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                   `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesCNAMEFlatteningJSON `json:"-"`
}

Whether or not cname flattening is on.

func (*SettingEditResponseZonesCNAMEFlattening) UnmarshalJSON

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

type SettingEditResponseZonesCNAMEFlatteningEditable

type SettingEditResponseZonesCNAMEFlatteningEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesCNAMEFlatteningEditableTrue  SettingEditResponseZonesCNAMEFlatteningEditable = true
	SettingEditResponseZonesCNAMEFlatteningEditableFalse SettingEditResponseZonesCNAMEFlatteningEditable = false
)

func (SettingEditResponseZonesCNAMEFlatteningEditable) IsKnown

type SettingEditResponseZonesCNAMEFlatteningID

type SettingEditResponseZonesCNAMEFlatteningID string

How to flatten the cname destination.

const (
	SettingEditResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingEditResponseZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingEditResponseZonesCNAMEFlatteningID) IsKnown

type SettingEditResponseZonesCNAMEFlatteningValue

type SettingEditResponseZonesCNAMEFlatteningValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesCNAMEFlatteningValueFlattenAtRoot SettingEditResponseZonesCNAMEFlatteningValue = "flatten_at_root"
	SettingEditResponseZonesCNAMEFlatteningValueFlattenAll    SettingEditResponseZonesCNAMEFlatteningValue = "flatten_all"
)

func (SettingEditResponseZonesCNAMEFlatteningValue) IsKnown

type SettingEditResponseZonesMaxUpload

type SettingEditResponseZonesMaxUpload struct {
	// identifier of the zone setting.
	ID SettingEditResponseZonesMaxUploadID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesMaxUploadValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesMaxUploadEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                             `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesMaxUploadJSON `json:"-"`
}

Maximum size of an allowable upload.

func (*SettingEditResponseZonesMaxUpload) UnmarshalJSON

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

type SettingEditResponseZonesMaxUploadEditable

type SettingEditResponseZonesMaxUploadEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesMaxUploadEditableTrue  SettingEditResponseZonesMaxUploadEditable = true
	SettingEditResponseZonesMaxUploadEditableFalse SettingEditResponseZonesMaxUploadEditable = false
)

func (SettingEditResponseZonesMaxUploadEditable) IsKnown

type SettingEditResponseZonesMaxUploadID

type SettingEditResponseZonesMaxUploadID string

identifier of the zone setting.

const (
	SettingEditResponseZonesMaxUploadIDMaxUpload SettingEditResponseZonesMaxUploadID = "max_upload"
)

func (SettingEditResponseZonesMaxUploadID) IsKnown

type SettingEditResponseZonesMaxUploadValue

type SettingEditResponseZonesMaxUploadValue float64

Current value of the zone setting.

const (
	SettingEditResponseZonesMaxUploadValue100 SettingEditResponseZonesMaxUploadValue = 100
	SettingEditResponseZonesMaxUploadValue200 SettingEditResponseZonesMaxUploadValue = 200
	SettingEditResponseZonesMaxUploadValue500 SettingEditResponseZonesMaxUploadValue = 500
)

func (SettingEditResponseZonesMaxUploadValue) IsKnown

type SettingEditResponseZonesReplaceInsecureJS

type SettingEditResponseZonesReplaceInsecureJS struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesReplaceInsecureJSID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesReplaceInsecureJSValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesReplaceInsecureJSEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                     `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesReplaceInsecureJSJSON `json:"-"`
}

Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io.

func (*SettingEditResponseZonesReplaceInsecureJS) UnmarshalJSON

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

type SettingEditResponseZonesReplaceInsecureJSEditable

type SettingEditResponseZonesReplaceInsecureJSEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesReplaceInsecureJSEditableTrue  SettingEditResponseZonesReplaceInsecureJSEditable = true
	SettingEditResponseZonesReplaceInsecureJSEditableFalse SettingEditResponseZonesReplaceInsecureJSEditable = false
)

func (SettingEditResponseZonesReplaceInsecureJSEditable) IsKnown

type SettingEditResponseZonesReplaceInsecureJSID

type SettingEditResponseZonesReplaceInsecureJSID string

ID of the zone setting.

const (
	SettingEditResponseZonesReplaceInsecureJSIDReplaceInsecureJS SettingEditResponseZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingEditResponseZonesReplaceInsecureJSID) IsKnown

type SettingEditResponseZonesReplaceInsecureJSValue

type SettingEditResponseZonesReplaceInsecureJSValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesReplaceInsecureJSValueOn  SettingEditResponseZonesReplaceInsecureJSValue = "on"
	SettingEditResponseZonesReplaceInsecureJSValueOff SettingEditResponseZonesReplaceInsecureJSValue = "off"
)

func (SettingEditResponseZonesReplaceInsecureJSValue) IsKnown

type SettingEditResponseZonesSchemasAlwaysUseHTTPS

type SettingEditResponseZonesSchemasAlwaysUseHTTPS struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasAlwaysUseHTTPSID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasAlwaysUseHTTPSValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasAlwaysUseHTTPSEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                         `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasAlwaysUseHTTPSJSON `json:"-"`
}

Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.

func (*SettingEditResponseZonesSchemasAlwaysUseHTTPS) UnmarshalJSON

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

type SettingEditResponseZonesSchemasAlwaysUseHTTPSEditable

type SettingEditResponseZonesSchemasAlwaysUseHTTPSEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasAlwaysUseHTTPSEditableTrue  SettingEditResponseZonesSchemasAlwaysUseHTTPSEditable = true
	SettingEditResponseZonesSchemasAlwaysUseHTTPSEditableFalse SettingEditResponseZonesSchemasAlwaysUseHTTPSEditable = false
)

func (SettingEditResponseZonesSchemasAlwaysUseHTTPSEditable) IsKnown

type SettingEditResponseZonesSchemasAlwaysUseHTTPSID

type SettingEditResponseZonesSchemasAlwaysUseHTTPSID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasAlwaysUseHTTPSIDAlwaysUseHTTPS SettingEditResponseZonesSchemasAlwaysUseHTTPSID = "always_use_https"
)

func (SettingEditResponseZonesSchemasAlwaysUseHTTPSID) IsKnown

type SettingEditResponseZonesSchemasAlwaysUseHTTPSValue

type SettingEditResponseZonesSchemasAlwaysUseHTTPSValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasAlwaysUseHTTPSValueOn  SettingEditResponseZonesSchemasAlwaysUseHTTPSValue = "on"
	SettingEditResponseZonesSchemasAlwaysUseHTTPSValueOff SettingEditResponseZonesSchemasAlwaysUseHTTPSValue = "off"
)

func (SettingEditResponseZonesSchemasAlwaysUseHTTPSValue) IsKnown

type SettingEditResponseZonesSchemasAutomaticHTTPSRewrites

type SettingEditResponseZonesSchemasAutomaticHTTPSRewrites struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                 `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasAutomaticHTTPSRewritesJSON `json:"-"`
}

Enable the Automatic HTTPS Rewrites feature for this zone.

func (*SettingEditResponseZonesSchemasAutomaticHTTPSRewrites) UnmarshalJSON

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

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditable

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditableTrue  SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditable = true
	SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditableFalse SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditable = false
)

func (SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditable) IsKnown

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasAutomaticHTTPSRewritesIDAutomaticHTTPSRewrites SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

func (SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID) IsKnown

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValueOn  SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue = "on"
	SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValueOff SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue = "off"
)

func (SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue) IsKnown

type SettingEditResponseZonesSchemasAutomaticPlatformOptimization

type SettingEditResponseZonesSchemasAutomaticPlatformOptimization struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID `json:"id,required"`
	// Current value of the zone setting.
	Value AutomaticPlatformOptimization `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                        `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasAutomaticPlatformOptimizationJSON `json:"-"`
}

[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.

func (*SettingEditResponseZonesSchemasAutomaticPlatformOptimization) UnmarshalJSON

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditableTrue  SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable = true
	SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditableFalse SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable = false
)

func (SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown

type SettingEditResponseZonesSchemasBrowserCacheTTL

type SettingEditResponseZonesSchemasBrowserCacheTTL struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasBrowserCacheTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasBrowserCacheTTLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasBrowserCacheTTLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                          `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasBrowserCacheTTLJSON `json:"-"`
}

Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).

func (*SettingEditResponseZonesSchemasBrowserCacheTTL) UnmarshalJSON

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

type SettingEditResponseZonesSchemasBrowserCacheTTLEditable

type SettingEditResponseZonesSchemasBrowserCacheTTLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasBrowserCacheTTLEditableTrue  SettingEditResponseZonesSchemasBrowserCacheTTLEditable = true
	SettingEditResponseZonesSchemasBrowserCacheTTLEditableFalse SettingEditResponseZonesSchemasBrowserCacheTTLEditable = false
)

func (SettingEditResponseZonesSchemasBrowserCacheTTLEditable) IsKnown

type SettingEditResponseZonesSchemasBrowserCacheTTLID

type SettingEditResponseZonesSchemasBrowserCacheTTLID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasBrowserCacheTTLIDBrowserCacheTTL SettingEditResponseZonesSchemasBrowserCacheTTLID = "browser_cache_ttl"
)

func (SettingEditResponseZonesSchemasBrowserCacheTTLID) IsKnown

type SettingEditResponseZonesSchemasBrowserCacheTTLValue

type SettingEditResponseZonesSchemasBrowserCacheTTLValue float64

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasBrowserCacheTTLValue0        SettingEditResponseZonesSchemasBrowserCacheTTLValue = 0
	SettingEditResponseZonesSchemasBrowserCacheTTLValue30       SettingEditResponseZonesSchemasBrowserCacheTTLValue = 30
	SettingEditResponseZonesSchemasBrowserCacheTTLValue60       SettingEditResponseZonesSchemasBrowserCacheTTLValue = 60
	SettingEditResponseZonesSchemasBrowserCacheTTLValue120      SettingEditResponseZonesSchemasBrowserCacheTTLValue = 120
	SettingEditResponseZonesSchemasBrowserCacheTTLValue300      SettingEditResponseZonesSchemasBrowserCacheTTLValue = 300
	SettingEditResponseZonesSchemasBrowserCacheTTLValue1200     SettingEditResponseZonesSchemasBrowserCacheTTLValue = 1200
	SettingEditResponseZonesSchemasBrowserCacheTTLValue1800     SettingEditResponseZonesSchemasBrowserCacheTTLValue = 1800
	SettingEditResponseZonesSchemasBrowserCacheTTLValue3600     SettingEditResponseZonesSchemasBrowserCacheTTLValue = 3600
	SettingEditResponseZonesSchemasBrowserCacheTTLValue7200     SettingEditResponseZonesSchemasBrowserCacheTTLValue = 7200
	SettingEditResponseZonesSchemasBrowserCacheTTLValue10800    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 10800
	SettingEditResponseZonesSchemasBrowserCacheTTLValue14400    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 14400
	SettingEditResponseZonesSchemasBrowserCacheTTLValue18000    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 18000
	SettingEditResponseZonesSchemasBrowserCacheTTLValue28800    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 28800
	SettingEditResponseZonesSchemasBrowserCacheTTLValue43200    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 43200
	SettingEditResponseZonesSchemasBrowserCacheTTLValue57600    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 57600
	SettingEditResponseZonesSchemasBrowserCacheTTLValue72000    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 72000
	SettingEditResponseZonesSchemasBrowserCacheTTLValue86400    SettingEditResponseZonesSchemasBrowserCacheTTLValue = 86400
	SettingEditResponseZonesSchemasBrowserCacheTTLValue172800   SettingEditResponseZonesSchemasBrowserCacheTTLValue = 172800
	SettingEditResponseZonesSchemasBrowserCacheTTLValue259200   SettingEditResponseZonesSchemasBrowserCacheTTLValue = 259200
	SettingEditResponseZonesSchemasBrowserCacheTTLValue345600   SettingEditResponseZonesSchemasBrowserCacheTTLValue = 345600
	SettingEditResponseZonesSchemasBrowserCacheTTLValue432000   SettingEditResponseZonesSchemasBrowserCacheTTLValue = 432000
	SettingEditResponseZonesSchemasBrowserCacheTTLValue691200   SettingEditResponseZonesSchemasBrowserCacheTTLValue = 691200
	SettingEditResponseZonesSchemasBrowserCacheTTLValue1382400  SettingEditResponseZonesSchemasBrowserCacheTTLValue = 1382400
	SettingEditResponseZonesSchemasBrowserCacheTTLValue2073600  SettingEditResponseZonesSchemasBrowserCacheTTLValue = 2073600
	SettingEditResponseZonesSchemasBrowserCacheTTLValue2678400  SettingEditResponseZonesSchemasBrowserCacheTTLValue = 2678400
	SettingEditResponseZonesSchemasBrowserCacheTTLValue5356800  SettingEditResponseZonesSchemasBrowserCacheTTLValue = 5356800
	SettingEditResponseZonesSchemasBrowserCacheTTLValue16070400 SettingEditResponseZonesSchemasBrowserCacheTTLValue = 16070400
	SettingEditResponseZonesSchemasBrowserCacheTTLValue31536000 SettingEditResponseZonesSchemasBrowserCacheTTLValue = 31536000
)

func (SettingEditResponseZonesSchemasBrowserCacheTTLValue) IsKnown

type SettingEditResponseZonesSchemasBrowserCheck

type SettingEditResponseZonesSchemasBrowserCheck struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasBrowserCheckID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasBrowserCheckValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasBrowserCheckEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                       `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasBrowserCheckJSON `json:"-"`
}

Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).

func (*SettingEditResponseZonesSchemasBrowserCheck) UnmarshalJSON

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

type SettingEditResponseZonesSchemasBrowserCheckEditable

type SettingEditResponseZonesSchemasBrowserCheckEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasBrowserCheckEditableTrue  SettingEditResponseZonesSchemasBrowserCheckEditable = true
	SettingEditResponseZonesSchemasBrowserCheckEditableFalse SettingEditResponseZonesSchemasBrowserCheckEditable = false
)

func (SettingEditResponseZonesSchemasBrowserCheckEditable) IsKnown

type SettingEditResponseZonesSchemasBrowserCheckID

type SettingEditResponseZonesSchemasBrowserCheckID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasBrowserCheckIDBrowserCheck SettingEditResponseZonesSchemasBrowserCheckID = "browser_check"
)

func (SettingEditResponseZonesSchemasBrowserCheckID) IsKnown

type SettingEditResponseZonesSchemasBrowserCheckValue

type SettingEditResponseZonesSchemasBrowserCheckValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasBrowserCheckValueOn  SettingEditResponseZonesSchemasBrowserCheckValue = "on"
	SettingEditResponseZonesSchemasBrowserCheckValueOff SettingEditResponseZonesSchemasBrowserCheckValue = "off"
)

func (SettingEditResponseZonesSchemasBrowserCheckValue) IsKnown

type SettingEditResponseZonesSchemasCacheLevel

type SettingEditResponseZonesSchemasCacheLevel struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasCacheLevelID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasCacheLevelValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasCacheLevelEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                     `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasCacheLevelJSON `json:"-"`
}

Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).

func (*SettingEditResponseZonesSchemasCacheLevel) UnmarshalJSON

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

type SettingEditResponseZonesSchemasCacheLevelEditable

type SettingEditResponseZonesSchemasCacheLevelEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasCacheLevelEditableTrue  SettingEditResponseZonesSchemasCacheLevelEditable = true
	SettingEditResponseZonesSchemasCacheLevelEditableFalse SettingEditResponseZonesSchemasCacheLevelEditable = false
)

func (SettingEditResponseZonesSchemasCacheLevelEditable) IsKnown

type SettingEditResponseZonesSchemasCacheLevelID

type SettingEditResponseZonesSchemasCacheLevelID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasCacheLevelIDCacheLevel SettingEditResponseZonesSchemasCacheLevelID = "cache_level"
)

func (SettingEditResponseZonesSchemasCacheLevelID) IsKnown

type SettingEditResponseZonesSchemasCacheLevelValue

type SettingEditResponseZonesSchemasCacheLevelValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasCacheLevelValueAggressive SettingEditResponseZonesSchemasCacheLevelValue = "aggressive"
	SettingEditResponseZonesSchemasCacheLevelValueBasic      SettingEditResponseZonesSchemasCacheLevelValue = "basic"
	SettingEditResponseZonesSchemasCacheLevelValueSimplified SettingEditResponseZonesSchemasCacheLevelValue = "simplified"
)

func (SettingEditResponseZonesSchemasCacheLevelValue) IsKnown

type SettingEditResponseZonesSchemasEdgeCacheTTL

type SettingEditResponseZonesSchemasEdgeCacheTTL struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasEdgeCacheTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasEdgeCacheTTLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasEdgeCacheTTLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                       `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasEdgeCacheTTLJSON `json:"-"`
}

Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.

func (*SettingEditResponseZonesSchemasEdgeCacheTTL) UnmarshalJSON

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

type SettingEditResponseZonesSchemasEdgeCacheTTLEditable

type SettingEditResponseZonesSchemasEdgeCacheTTLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasEdgeCacheTTLEditableTrue  SettingEditResponseZonesSchemasEdgeCacheTTLEditable = true
	SettingEditResponseZonesSchemasEdgeCacheTTLEditableFalse SettingEditResponseZonesSchemasEdgeCacheTTLEditable = false
)

func (SettingEditResponseZonesSchemasEdgeCacheTTLEditable) IsKnown

type SettingEditResponseZonesSchemasEdgeCacheTTLID

type SettingEditResponseZonesSchemasEdgeCacheTTLID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasEdgeCacheTTLIDEdgeCacheTTL SettingEditResponseZonesSchemasEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingEditResponseZonesSchemasEdgeCacheTTLID) IsKnown

type SettingEditResponseZonesSchemasEdgeCacheTTLValue

type SettingEditResponseZonesSchemasEdgeCacheTTLValue float64

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasEdgeCacheTTLValue30     SettingEditResponseZonesSchemasEdgeCacheTTLValue = 30
	SettingEditResponseZonesSchemasEdgeCacheTTLValue60     SettingEditResponseZonesSchemasEdgeCacheTTLValue = 60
	SettingEditResponseZonesSchemasEdgeCacheTTLValue300    SettingEditResponseZonesSchemasEdgeCacheTTLValue = 300
	SettingEditResponseZonesSchemasEdgeCacheTTLValue1200   SettingEditResponseZonesSchemasEdgeCacheTTLValue = 1200
	SettingEditResponseZonesSchemasEdgeCacheTTLValue1800   SettingEditResponseZonesSchemasEdgeCacheTTLValue = 1800
	SettingEditResponseZonesSchemasEdgeCacheTTLValue3600   SettingEditResponseZonesSchemasEdgeCacheTTLValue = 3600
	SettingEditResponseZonesSchemasEdgeCacheTTLValue7200   SettingEditResponseZonesSchemasEdgeCacheTTLValue = 7200
	SettingEditResponseZonesSchemasEdgeCacheTTLValue10800  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 10800
	SettingEditResponseZonesSchemasEdgeCacheTTLValue14400  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 14400
	SettingEditResponseZonesSchemasEdgeCacheTTLValue18000  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 18000
	SettingEditResponseZonesSchemasEdgeCacheTTLValue28800  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 28800
	SettingEditResponseZonesSchemasEdgeCacheTTLValue43200  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 43200
	SettingEditResponseZonesSchemasEdgeCacheTTLValue57600  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 57600
	SettingEditResponseZonesSchemasEdgeCacheTTLValue72000  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 72000
	SettingEditResponseZonesSchemasEdgeCacheTTLValue86400  SettingEditResponseZonesSchemasEdgeCacheTTLValue = 86400
	SettingEditResponseZonesSchemasEdgeCacheTTLValue172800 SettingEditResponseZonesSchemasEdgeCacheTTLValue = 172800
	SettingEditResponseZonesSchemasEdgeCacheTTLValue259200 SettingEditResponseZonesSchemasEdgeCacheTTLValue = 259200
	SettingEditResponseZonesSchemasEdgeCacheTTLValue345600 SettingEditResponseZonesSchemasEdgeCacheTTLValue = 345600
	SettingEditResponseZonesSchemasEdgeCacheTTLValue432000 SettingEditResponseZonesSchemasEdgeCacheTTLValue = 432000
	SettingEditResponseZonesSchemasEdgeCacheTTLValue518400 SettingEditResponseZonesSchemasEdgeCacheTTLValue = 518400
	SettingEditResponseZonesSchemasEdgeCacheTTLValue604800 SettingEditResponseZonesSchemasEdgeCacheTTLValue = 604800
)

func (SettingEditResponseZonesSchemasEdgeCacheTTLValue) IsKnown

type SettingEditResponseZonesSchemasEmailObfuscation

type SettingEditResponseZonesSchemasEmailObfuscation struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasEmailObfuscationID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasEmailObfuscationValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasEmailObfuscationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                           `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasEmailObfuscationJSON `json:"-"`
}

Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).

func (*SettingEditResponseZonesSchemasEmailObfuscation) UnmarshalJSON

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

type SettingEditResponseZonesSchemasEmailObfuscationEditable

type SettingEditResponseZonesSchemasEmailObfuscationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasEmailObfuscationEditableTrue  SettingEditResponseZonesSchemasEmailObfuscationEditable = true
	SettingEditResponseZonesSchemasEmailObfuscationEditableFalse SettingEditResponseZonesSchemasEmailObfuscationEditable = false
)

func (SettingEditResponseZonesSchemasEmailObfuscationEditable) IsKnown

type SettingEditResponseZonesSchemasEmailObfuscationID

type SettingEditResponseZonesSchemasEmailObfuscationID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasEmailObfuscationIDEmailObfuscation SettingEditResponseZonesSchemasEmailObfuscationID = "email_obfuscation"
)

func (SettingEditResponseZonesSchemasEmailObfuscationID) IsKnown

type SettingEditResponseZonesSchemasEmailObfuscationValue

type SettingEditResponseZonesSchemasEmailObfuscationValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasEmailObfuscationValueOn  SettingEditResponseZonesSchemasEmailObfuscationValue = "on"
	SettingEditResponseZonesSchemasEmailObfuscationValueOff SettingEditResponseZonesSchemasEmailObfuscationValue = "off"
)

func (SettingEditResponseZonesSchemasEmailObfuscationValue) IsKnown

type SettingEditResponseZonesSchemasIPGeolocation

type SettingEditResponseZonesSchemasIPGeolocation struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasIPGeolocationID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasIPGeolocationValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasIPGeolocationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                        `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasIPGeolocationJSON `json:"-"`
}

Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).

func (*SettingEditResponseZonesSchemasIPGeolocation) UnmarshalJSON

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

type SettingEditResponseZonesSchemasIPGeolocationEditable

type SettingEditResponseZonesSchemasIPGeolocationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasIPGeolocationEditableTrue  SettingEditResponseZonesSchemasIPGeolocationEditable = true
	SettingEditResponseZonesSchemasIPGeolocationEditableFalse SettingEditResponseZonesSchemasIPGeolocationEditable = false
)

func (SettingEditResponseZonesSchemasIPGeolocationEditable) IsKnown

type SettingEditResponseZonesSchemasIPGeolocationID

type SettingEditResponseZonesSchemasIPGeolocationID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasIPGeolocationIDIPGeolocation SettingEditResponseZonesSchemasIPGeolocationID = "ip_geolocation"
)

func (SettingEditResponseZonesSchemasIPGeolocationID) IsKnown

type SettingEditResponseZonesSchemasIPGeolocationValue

type SettingEditResponseZonesSchemasIPGeolocationValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasIPGeolocationValueOn  SettingEditResponseZonesSchemasIPGeolocationValue = "on"
	SettingEditResponseZonesSchemasIPGeolocationValueOff SettingEditResponseZonesSchemasIPGeolocationValue = "off"
)

func (SettingEditResponseZonesSchemasIPGeolocationValue) IsKnown

type SettingEditResponseZonesSchemasMirage

type SettingEditResponseZonesSchemasMirage struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasMirageID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasMirageValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasMirageEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                 `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasMirageJSON `json:"-"`
}

Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.

func (*SettingEditResponseZonesSchemasMirage) UnmarshalJSON

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

type SettingEditResponseZonesSchemasMirageEditable

type SettingEditResponseZonesSchemasMirageEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasMirageEditableTrue  SettingEditResponseZonesSchemasMirageEditable = true
	SettingEditResponseZonesSchemasMirageEditableFalse SettingEditResponseZonesSchemasMirageEditable = false
)

func (SettingEditResponseZonesSchemasMirageEditable) IsKnown

type SettingEditResponseZonesSchemasMirageID

type SettingEditResponseZonesSchemasMirageID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasMirageIDMirage SettingEditResponseZonesSchemasMirageID = "mirage"
)

func (SettingEditResponseZonesSchemasMirageID) IsKnown

type SettingEditResponseZonesSchemasMirageValue

type SettingEditResponseZonesSchemasMirageValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasMirageValueOn  SettingEditResponseZonesSchemasMirageValue = "on"
	SettingEditResponseZonesSchemasMirageValueOff SettingEditResponseZonesSchemasMirageValue = "off"
)

func (SettingEditResponseZonesSchemasMirageValue) IsKnown

type SettingEditResponseZonesSchemasOpportunisticEncryption

type SettingEditResponseZonesSchemasOpportunisticEncryption struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasOpportunisticEncryptionID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasOpportunisticEncryptionValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasOpportunisticEncryptionEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                  `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasOpportunisticEncryptionJSON `json:"-"`
}

Enables the Opportunistic Encryption feature for a zone.

func (*SettingEditResponseZonesSchemasOpportunisticEncryption) UnmarshalJSON

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

type SettingEditResponseZonesSchemasOpportunisticEncryptionEditable

type SettingEditResponseZonesSchemasOpportunisticEncryptionEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasOpportunisticEncryptionEditableTrue  SettingEditResponseZonesSchemasOpportunisticEncryptionEditable = true
	SettingEditResponseZonesSchemasOpportunisticEncryptionEditableFalse SettingEditResponseZonesSchemasOpportunisticEncryptionEditable = false
)

func (SettingEditResponseZonesSchemasOpportunisticEncryptionEditable) IsKnown

type SettingEditResponseZonesSchemasOpportunisticEncryptionID

type SettingEditResponseZonesSchemasOpportunisticEncryptionID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasOpportunisticEncryptionIDOpportunisticEncryption SettingEditResponseZonesSchemasOpportunisticEncryptionID = "opportunistic_encryption"
)

func (SettingEditResponseZonesSchemasOpportunisticEncryptionID) IsKnown

type SettingEditResponseZonesSchemasOpportunisticEncryptionValue

type SettingEditResponseZonesSchemasOpportunisticEncryptionValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasOpportunisticEncryptionValueOn  SettingEditResponseZonesSchemasOpportunisticEncryptionValue = "on"
	SettingEditResponseZonesSchemasOpportunisticEncryptionValueOff SettingEditResponseZonesSchemasOpportunisticEncryptionValue = "off"
)

func (SettingEditResponseZonesSchemasOpportunisticEncryptionValue) IsKnown

type SettingEditResponseZonesSchemasOriginErrorPagePassThru

type SettingEditResponseZonesSchemasOriginErrorPagePassThru struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasOriginErrorPagePassThruID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasOriginErrorPagePassThruValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasOriginErrorPagePassThruEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                  `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasOriginErrorPagePassThruJSON `json:"-"`
}

Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.

func (*SettingEditResponseZonesSchemasOriginErrorPagePassThru) UnmarshalJSON

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

type SettingEditResponseZonesSchemasOriginErrorPagePassThruEditable

type SettingEditResponseZonesSchemasOriginErrorPagePassThruEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasOriginErrorPagePassThruEditableTrue  SettingEditResponseZonesSchemasOriginErrorPagePassThruEditable = true
	SettingEditResponseZonesSchemasOriginErrorPagePassThruEditableFalse SettingEditResponseZonesSchemasOriginErrorPagePassThruEditable = false
)

func (SettingEditResponseZonesSchemasOriginErrorPagePassThruEditable) IsKnown

type SettingEditResponseZonesSchemasOriginErrorPagePassThruID

type SettingEditResponseZonesSchemasOriginErrorPagePassThruID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasOriginErrorPagePassThruIDOriginErrorPagePassThru SettingEditResponseZonesSchemasOriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

func (SettingEditResponseZonesSchemasOriginErrorPagePassThruID) IsKnown

type SettingEditResponseZonesSchemasOriginErrorPagePassThruValue

type SettingEditResponseZonesSchemasOriginErrorPagePassThruValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasOriginErrorPagePassThruValueOn  SettingEditResponseZonesSchemasOriginErrorPagePassThruValue = "on"
	SettingEditResponseZonesSchemasOriginErrorPagePassThruValueOff SettingEditResponseZonesSchemasOriginErrorPagePassThruValue = "off"
)

func (SettingEditResponseZonesSchemasOriginErrorPagePassThruValue) IsKnown

type SettingEditResponseZonesSchemasPolish

type SettingEditResponseZonesSchemasPolish struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasPolishID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasPolishValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasPolishEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                 `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasPolishJSON `json:"-"`
}

Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.

func (*SettingEditResponseZonesSchemasPolish) UnmarshalJSON

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

type SettingEditResponseZonesSchemasPolishEditable

type SettingEditResponseZonesSchemasPolishEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasPolishEditableTrue  SettingEditResponseZonesSchemasPolishEditable = true
	SettingEditResponseZonesSchemasPolishEditableFalse SettingEditResponseZonesSchemasPolishEditable = false
)

func (SettingEditResponseZonesSchemasPolishEditable) IsKnown

type SettingEditResponseZonesSchemasPolishID

type SettingEditResponseZonesSchemasPolishID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasPolishIDPolish SettingEditResponseZonesSchemasPolishID = "polish"
)

func (SettingEditResponseZonesSchemasPolishID) IsKnown

type SettingEditResponseZonesSchemasPolishValue

type SettingEditResponseZonesSchemasPolishValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasPolishValueOff      SettingEditResponseZonesSchemasPolishValue = "off"
	SettingEditResponseZonesSchemasPolishValueLossless SettingEditResponseZonesSchemasPolishValue = "lossless"
	SettingEditResponseZonesSchemasPolishValueLossy    SettingEditResponseZonesSchemasPolishValue = "lossy"
)

func (SettingEditResponseZonesSchemasPolishValue) IsKnown

type SettingEditResponseZonesSchemasResponseBuffering

type SettingEditResponseZonesSchemasResponseBuffering struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasResponseBufferingID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasResponseBufferingValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasResponseBufferingEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                            `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasResponseBufferingJSON `json:"-"`
}

Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.

func (*SettingEditResponseZonesSchemasResponseBuffering) UnmarshalJSON

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

type SettingEditResponseZonesSchemasResponseBufferingEditable

type SettingEditResponseZonesSchemasResponseBufferingEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasResponseBufferingEditableTrue  SettingEditResponseZonesSchemasResponseBufferingEditable = true
	SettingEditResponseZonesSchemasResponseBufferingEditableFalse SettingEditResponseZonesSchemasResponseBufferingEditable = false
)

func (SettingEditResponseZonesSchemasResponseBufferingEditable) IsKnown

type SettingEditResponseZonesSchemasResponseBufferingID

type SettingEditResponseZonesSchemasResponseBufferingID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasResponseBufferingIDResponseBuffering SettingEditResponseZonesSchemasResponseBufferingID = "response_buffering"
)

func (SettingEditResponseZonesSchemasResponseBufferingID) IsKnown

type SettingEditResponseZonesSchemasResponseBufferingValue

type SettingEditResponseZonesSchemasResponseBufferingValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasResponseBufferingValueOn  SettingEditResponseZonesSchemasResponseBufferingValue = "on"
	SettingEditResponseZonesSchemasResponseBufferingValueOff SettingEditResponseZonesSchemasResponseBufferingValue = "off"
)

func (SettingEditResponseZonesSchemasResponseBufferingValue) IsKnown

type SettingEditResponseZonesSchemasRocketLoader

type SettingEditResponseZonesSchemasRocketLoader struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasRocketLoaderID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasRocketLoaderValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasRocketLoaderEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                       `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasRocketLoaderJSON `json:"-"`
}

Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.

func (*SettingEditResponseZonesSchemasRocketLoader) UnmarshalJSON

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

type SettingEditResponseZonesSchemasRocketLoaderEditable

type SettingEditResponseZonesSchemasRocketLoaderEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasRocketLoaderEditableTrue  SettingEditResponseZonesSchemasRocketLoaderEditable = true
	SettingEditResponseZonesSchemasRocketLoaderEditableFalse SettingEditResponseZonesSchemasRocketLoaderEditable = false
)

func (SettingEditResponseZonesSchemasRocketLoaderEditable) IsKnown

type SettingEditResponseZonesSchemasRocketLoaderID

type SettingEditResponseZonesSchemasRocketLoaderID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasRocketLoaderIDRocketLoader SettingEditResponseZonesSchemasRocketLoaderID = "rocket_loader"
)

func (SettingEditResponseZonesSchemasRocketLoaderID) IsKnown

type SettingEditResponseZonesSchemasRocketLoaderValue

type SettingEditResponseZonesSchemasRocketLoaderValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasRocketLoaderValueOn  SettingEditResponseZonesSchemasRocketLoaderValue = "on"
	SettingEditResponseZonesSchemasRocketLoaderValueOff SettingEditResponseZonesSchemasRocketLoaderValue = "off"
)

func (SettingEditResponseZonesSchemasRocketLoaderValue) IsKnown

type SettingEditResponseZonesSchemasSSL

type SettingEditResponseZonesSchemasSSL struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasSSLID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasSSLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasSSLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                              `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasSSLJSON `json:"-"`
}

SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).

func (*SettingEditResponseZonesSchemasSSL) UnmarshalJSON

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

type SettingEditResponseZonesSchemasSSLEditable

type SettingEditResponseZonesSchemasSSLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasSSLEditableTrue  SettingEditResponseZonesSchemasSSLEditable = true
	SettingEditResponseZonesSchemasSSLEditableFalse SettingEditResponseZonesSchemasSSLEditable = false
)

func (SettingEditResponseZonesSchemasSSLEditable) IsKnown

type SettingEditResponseZonesSchemasSSLID

type SettingEditResponseZonesSchemasSSLID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasSSLIDSSL SettingEditResponseZonesSchemasSSLID = "ssl"
)

func (SettingEditResponseZonesSchemasSSLID) IsKnown

type SettingEditResponseZonesSchemasSSLValue

type SettingEditResponseZonesSchemasSSLValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasSSLValueOff      SettingEditResponseZonesSchemasSSLValue = "off"
	SettingEditResponseZonesSchemasSSLValueFlexible SettingEditResponseZonesSchemasSSLValue = "flexible"
	SettingEditResponseZonesSchemasSSLValueFull     SettingEditResponseZonesSchemasSSLValue = "full"
	SettingEditResponseZonesSchemasSSLValueStrict   SettingEditResponseZonesSchemasSSLValue = "strict"
)

func (SettingEditResponseZonesSchemasSSLValue) IsKnown

type SettingEditResponseZonesSchemasSecurityLevel

type SettingEditResponseZonesSchemasSecurityLevel struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasSecurityLevelID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasSecurityLevelValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasSecurityLevelEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                        `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasSecurityLevelJSON `json:"-"`
}

Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).

func (*SettingEditResponseZonesSchemasSecurityLevel) UnmarshalJSON

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

type SettingEditResponseZonesSchemasSecurityLevelEditable

type SettingEditResponseZonesSchemasSecurityLevelEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasSecurityLevelEditableTrue  SettingEditResponseZonesSchemasSecurityLevelEditable = true
	SettingEditResponseZonesSchemasSecurityLevelEditableFalse SettingEditResponseZonesSchemasSecurityLevelEditable = false
)

func (SettingEditResponseZonesSchemasSecurityLevelEditable) IsKnown

type SettingEditResponseZonesSchemasSecurityLevelID

type SettingEditResponseZonesSchemasSecurityLevelID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasSecurityLevelIDSecurityLevel SettingEditResponseZonesSchemasSecurityLevelID = "security_level"
)

func (SettingEditResponseZonesSchemasSecurityLevelID) IsKnown

type SettingEditResponseZonesSchemasSecurityLevelValue

type SettingEditResponseZonesSchemasSecurityLevelValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasSecurityLevelValueOff            SettingEditResponseZonesSchemasSecurityLevelValue = "off"
	SettingEditResponseZonesSchemasSecurityLevelValueEssentiallyOff SettingEditResponseZonesSchemasSecurityLevelValue = "essentially_off"
	SettingEditResponseZonesSchemasSecurityLevelValueLow            SettingEditResponseZonesSchemasSecurityLevelValue = "low"
	SettingEditResponseZonesSchemasSecurityLevelValueMedium         SettingEditResponseZonesSchemasSecurityLevelValue = "medium"
	SettingEditResponseZonesSchemasSecurityLevelValueHigh           SettingEditResponseZonesSchemasSecurityLevelValue = "high"
	SettingEditResponseZonesSchemasSecurityLevelValueUnderAttack    SettingEditResponseZonesSchemasSecurityLevelValue = "under_attack"
)

func (SettingEditResponseZonesSchemasSecurityLevelValue) IsKnown

type SettingEditResponseZonesSchemasSortQueryStringForCache

type SettingEditResponseZonesSchemasSortQueryStringForCache struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasSortQueryStringForCacheID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasSortQueryStringForCacheValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasSortQueryStringForCacheEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                  `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasSortQueryStringForCacheJSON `json:"-"`
}

Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.

func (*SettingEditResponseZonesSchemasSortQueryStringForCache) UnmarshalJSON

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

type SettingEditResponseZonesSchemasSortQueryStringForCacheEditable

type SettingEditResponseZonesSchemasSortQueryStringForCacheEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasSortQueryStringForCacheEditableTrue  SettingEditResponseZonesSchemasSortQueryStringForCacheEditable = true
	SettingEditResponseZonesSchemasSortQueryStringForCacheEditableFalse SettingEditResponseZonesSchemasSortQueryStringForCacheEditable = false
)

func (SettingEditResponseZonesSchemasSortQueryStringForCacheEditable) IsKnown

type SettingEditResponseZonesSchemasSortQueryStringForCacheID

type SettingEditResponseZonesSchemasSortQueryStringForCacheID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasSortQueryStringForCacheIDSortQueryStringForCache SettingEditResponseZonesSchemasSortQueryStringForCacheID = "sort_query_string_for_cache"
)

func (SettingEditResponseZonesSchemasSortQueryStringForCacheID) IsKnown

type SettingEditResponseZonesSchemasSortQueryStringForCacheValue

type SettingEditResponseZonesSchemasSortQueryStringForCacheValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasSortQueryStringForCacheValueOn  SettingEditResponseZonesSchemasSortQueryStringForCacheValue = "on"
	SettingEditResponseZonesSchemasSortQueryStringForCacheValueOff SettingEditResponseZonesSchemasSortQueryStringForCacheValue = "off"
)

func (SettingEditResponseZonesSchemasSortQueryStringForCacheValue) IsKnown

type SettingEditResponseZonesSchemasTrueClientIPHeader

type SettingEditResponseZonesSchemasTrueClientIPHeader struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasTrueClientIPHeaderID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasTrueClientIPHeaderValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasTrueClientIPHeaderEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                             `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasTrueClientIPHeaderJSON `json:"-"`
}

Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.

func (*SettingEditResponseZonesSchemasTrueClientIPHeader) UnmarshalJSON

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

type SettingEditResponseZonesSchemasTrueClientIPHeaderEditable

type SettingEditResponseZonesSchemasTrueClientIPHeaderEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasTrueClientIPHeaderEditableTrue  SettingEditResponseZonesSchemasTrueClientIPHeaderEditable = true
	SettingEditResponseZonesSchemasTrueClientIPHeaderEditableFalse SettingEditResponseZonesSchemasTrueClientIPHeaderEditable = false
)

func (SettingEditResponseZonesSchemasTrueClientIPHeaderEditable) IsKnown

type SettingEditResponseZonesSchemasTrueClientIPHeaderID

type SettingEditResponseZonesSchemasTrueClientIPHeaderID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasTrueClientIPHeaderIDTrueClientIPHeader SettingEditResponseZonesSchemasTrueClientIPHeaderID = "true_client_ip_header"
)

func (SettingEditResponseZonesSchemasTrueClientIPHeaderID) IsKnown

type SettingEditResponseZonesSchemasTrueClientIPHeaderValue

type SettingEditResponseZonesSchemasTrueClientIPHeaderValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasTrueClientIPHeaderValueOn  SettingEditResponseZonesSchemasTrueClientIPHeaderValue = "on"
	SettingEditResponseZonesSchemasTrueClientIPHeaderValueOff SettingEditResponseZonesSchemasTrueClientIPHeaderValue = "off"
)

func (SettingEditResponseZonesSchemasTrueClientIPHeaderValue) IsKnown

type SettingEditResponseZonesSchemasWAF

type SettingEditResponseZonesSchemasWAF struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasWAFID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSchemasWAFValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSchemasWAFEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                              `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSchemasWAFJSON `json:"-"`
}

The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).

func (*SettingEditResponseZonesSchemasWAF) UnmarshalJSON

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

type SettingEditResponseZonesSchemasWAFEditable

type SettingEditResponseZonesSchemasWAFEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSchemasWAFEditableTrue  SettingEditResponseZonesSchemasWAFEditable = true
	SettingEditResponseZonesSchemasWAFEditableFalse SettingEditResponseZonesSchemasWAFEditable = false
)

func (SettingEditResponseZonesSchemasWAFEditable) IsKnown

type SettingEditResponseZonesSchemasWAFID

type SettingEditResponseZonesSchemasWAFID string

ID of the zone setting.

const (
	SettingEditResponseZonesSchemasWAFIDWAF SettingEditResponseZonesSchemasWAFID = "waf"
)

func (SettingEditResponseZonesSchemasWAFID) IsKnown

type SettingEditResponseZonesSchemasWAFValue

type SettingEditResponseZonesSchemasWAFValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSchemasWAFValueOn  SettingEditResponseZonesSchemasWAFValue = "on"
	SettingEditResponseZonesSchemasWAFValueOff SettingEditResponseZonesSchemasWAFValue = "off"
)

func (SettingEditResponseZonesSchemasWAFValue) IsKnown

type SettingEditResponseZonesSha1Support

type SettingEditResponseZonesSha1Support struct {
	// Zone setting identifier.
	ID SettingEditResponseZonesSha1SupportID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesSha1SupportValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesSha1SupportEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                               `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesSha1SupportJSON `json:"-"`
}

Allow SHA1 support.

func (*SettingEditResponseZonesSha1Support) UnmarshalJSON

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

type SettingEditResponseZonesSha1SupportEditable

type SettingEditResponseZonesSha1SupportEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesSha1SupportEditableTrue  SettingEditResponseZonesSha1SupportEditable = true
	SettingEditResponseZonesSha1SupportEditableFalse SettingEditResponseZonesSha1SupportEditable = false
)

func (SettingEditResponseZonesSha1SupportEditable) IsKnown

type SettingEditResponseZonesSha1SupportID

type SettingEditResponseZonesSha1SupportID string

Zone setting identifier.

const (
	SettingEditResponseZonesSha1SupportIDSha1Support SettingEditResponseZonesSha1SupportID = "sha1_support"
)

func (SettingEditResponseZonesSha1SupportID) IsKnown

type SettingEditResponseZonesSha1SupportValue

type SettingEditResponseZonesSha1SupportValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesSha1SupportValueOff SettingEditResponseZonesSha1SupportValue = "off"
	SettingEditResponseZonesSha1SupportValueOn  SettingEditResponseZonesSha1SupportValue = "on"
)

func (SettingEditResponseZonesSha1SupportValue) IsKnown

type SettingEditResponseZonesTLS1_2Only

type SettingEditResponseZonesTLS1_2Only struct {
	// Zone setting identifier.
	ID SettingEditResponseZonesTLS1_2OnlyID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesTLS1_2OnlyValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesTLS1_2OnlyEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                              `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesTls1_2OnlyJSON `json:"-"`
}

Only allows TLS1.2.

func (*SettingEditResponseZonesTLS1_2Only) UnmarshalJSON

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

type SettingEditResponseZonesTLS1_2OnlyEditable

type SettingEditResponseZonesTLS1_2OnlyEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingEditResponseZonesTLS1_2OnlyEditableTrue  SettingEditResponseZonesTLS1_2OnlyEditable = true
	SettingEditResponseZonesTLS1_2OnlyEditableFalse SettingEditResponseZonesTLS1_2OnlyEditable = false
)

func (SettingEditResponseZonesTLS1_2OnlyEditable) IsKnown

type SettingEditResponseZonesTLS1_2OnlyID

type SettingEditResponseZonesTLS1_2OnlyID string

Zone setting identifier.

const (
	SettingEditResponseZonesTLS1_2OnlyIDTLS1_2Only SettingEditResponseZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingEditResponseZonesTLS1_2OnlyID) IsKnown

type SettingEditResponseZonesTLS1_2OnlyValue

type SettingEditResponseZonesTLS1_2OnlyValue string

Current value of the zone setting.

const (
	SettingEditResponseZonesTLS1_2OnlyValueOff SettingEditResponseZonesTLS1_2OnlyValue = "off"
	SettingEditResponseZonesTLS1_2OnlyValueOn  SettingEditResponseZonesTLS1_2OnlyValue = "on"
)

func (SettingEditResponseZonesTLS1_2OnlyValue) IsKnown

type SettingGetParams

type SettingGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type SettingGetResponse

type SettingGetResponse struct {
	// ID of the zone setting.
	ID SettingGetResponseID `json:"id"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseEditable `json:"editable"`
	// ssl-recommender enrollment setting.
	Enabled bool `json:"enabled"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the zone setting. Notes: The interval (in seconds) from when
	// development mode expires (positive integer) or last expired (negative integer)
	// for the domain. If development mode has never been enabled, this value is false.
	TimeRemaining float64 `json:"time_remaining"`
	// This field can have the runtime type of [ZeroRTTValue], [AdvancedDDoSValue],
	// [AlwaysOnlineValue], [SettingGetResponseZonesSchemasAlwaysUseHTTPSValue],
	// [SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue], [BrotliValue],
	// [SettingGetResponseZonesSchemasBrowserCacheTTLValue],
	// [SettingGetResponseZonesSchemasBrowserCheckValue],
	// [SettingGetResponseZonesSchemasCacheLevelValue], [ChallengeTTLValue],
	// [[]string], [SettingGetResponseZonesCNAMEFlatteningValue],
	// [DevelopmentModeValue], [EarlyHintsValue],
	// [SettingGetResponseZonesSchemasEdgeCacheTTLValue],
	// [SettingGetResponseZonesSchemasEmailObfuscationValue], [H2PrioritizationValue],
	// [HotlinkProtectionValue], [HTTP2Value], [HTTP3Value], [ImageResizingValue],
	// [SettingGetResponseZonesSchemasIPGeolocationValue], [IPV6Value],
	// [SettingGetResponseZonesMaxUploadValue], [MinTLSVersionValue],
	// [SettingGetResponseZonesSchemasMirageValue], [NELValue],
	// [SettingGetResponseZonesSchemasOpportunisticEncryptionValue],
	// [OpportunisticOnionValue], [OrangeToOrangeValue],
	// [SettingGetResponseZonesSchemasOriginErrorPagePassThruValue],
	// [SettingGetResponseZonesSchemasPolishValue], [PrefetchPreloadValue], [float64],
	// [PseudoIPV4Value], [SettingGetResponseZonesReplaceInsecureJSValue],
	// [SettingGetResponseZonesSchemasResponseBufferingValue],
	// [SettingGetResponseZonesSchemasRocketLoaderValue],
	// [AutomaticPlatformOptimization], [SecurityHeadersValue],
	// [SettingGetResponseZonesSchemasSecurityLevelValue], [ServerSideExcludesValue],
	// [SettingGetResponseZonesSha1SupportValue],
	// [SettingGetResponseZonesSchemasSortQueryStringForCacheValue],
	// [SettingGetResponseZonesSchemasSSLValue],
	// [SettingGetResponseZonesTLS1_2OnlyValue], [TLS1_3Value], [TLSClientAuthValue],
	// [SettingGetResponseZonesSchemasTrueClientIPHeaderValue],
	// [SettingGetResponseZonesSchemasWAFValue], [WebPValue], [WebsocketValue].
	Value interface{}            `json:"value"`
	JSON  settingGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

0-RTT session resumption enabled for this zone.

func (SettingGetResponse) AsUnion

AsUnion returns a SettingGetResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.SettingGetResponseZonesSchemasAlwaysUseHTTPS, zones.SettingGetResponseZonesSchemasAutomaticHTTPSRewrites, zones.Brotli, zones.SettingGetResponseZonesSchemasBrowserCacheTTL, zones.SettingGetResponseZonesSchemasBrowserCheck, zones.SettingGetResponseZonesSchemasCacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingGetResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingGetResponseZonesSchemasEdgeCacheTTL, zones.SettingGetResponseZonesSchemasEmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.SettingGetResponseZonesSchemasIPGeolocation, zones.IPV6, zones.SettingGetResponseZonesMaxUpload, zones.MinTLSVersion, zones.SettingGetResponseZonesSchemasMirage, zones.NEL, zones.SettingGetResponseZonesSchemasOpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.SettingGetResponseZonesSchemasOriginErrorPagePassThru, zones.SettingGetResponseZonesSchemasPolish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingGetResponseZonesReplaceInsecureJS, zones.SettingGetResponseZonesSchemasResponseBuffering, zones.SettingGetResponseZonesSchemasRocketLoader, zones.SettingGetResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SettingGetResponseZonesSchemasSecurityLevel, zones.ServerSideExcludes, zones.SettingGetResponseZonesSha1Support, zones.SettingGetResponseZonesSchemasSortQueryStringForCache, zones.SettingGetResponseZonesSchemasSSL, zones.SSLRecommender, zones.SettingGetResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.SettingGetResponseZonesSchemasTrueClientIPHeader, zones.SettingGetResponseZonesSchemasWAF, zones.WebP, zones.Websocket.

func (*SettingGetResponse) UnmarshalJSON

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

type SettingGetResponseEditable

type SettingGetResponseEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseEditableTrue  SettingGetResponseEditable = true
	SettingGetResponseEditableFalse SettingGetResponseEditable = false
)

func (SettingGetResponseEditable) IsKnown

func (r SettingGetResponseEditable) IsKnown() bool

type SettingGetResponseEnvelope

type SettingGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// 0-RTT session resumption enabled for this zone.
	Result SettingGetResponse             `json:"result"`
	JSON   settingGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingGetResponseEnvelope) UnmarshalJSON

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

type SettingGetResponseID

type SettingGetResponseID string

ID of the zone setting.

const (
	SettingGetResponseID0rtt                          SettingGetResponseID = "0rtt"
	SettingGetResponseIDAdvancedDDoS                  SettingGetResponseID = "advanced_ddos"
	SettingGetResponseIDAlwaysOnline                  SettingGetResponseID = "always_online"
	SettingGetResponseIDAlwaysUseHTTPS                SettingGetResponseID = "always_use_https"
	SettingGetResponseIDAutomaticHTTPSRewrites        SettingGetResponseID = "automatic_https_rewrites"
	SettingGetResponseIDBrotli                        SettingGetResponseID = "brotli"
	SettingGetResponseIDBrowserCacheTTL               SettingGetResponseID = "browser_cache_ttl"
	SettingGetResponseIDBrowserCheck                  SettingGetResponseID = "browser_check"
	SettingGetResponseIDCacheLevel                    SettingGetResponseID = "cache_level"
	SettingGetResponseIDChallengeTTL                  SettingGetResponseID = "challenge_ttl"
	SettingGetResponseIDCiphers                       SettingGetResponseID = "ciphers"
	SettingGetResponseIDCNAMEFlattening               SettingGetResponseID = "cname_flattening"
	SettingGetResponseIDDevelopmentMode               SettingGetResponseID = "development_mode"
	SettingGetResponseIDEarlyHints                    SettingGetResponseID = "early_hints"
	SettingGetResponseIDEdgeCacheTTL                  SettingGetResponseID = "edge_cache_ttl"
	SettingGetResponseIDEmailObfuscation              SettingGetResponseID = "email_obfuscation"
	SettingGetResponseIDH2Prioritization              SettingGetResponseID = "h2_prioritization"
	SettingGetResponseIDHotlinkProtection             SettingGetResponseID = "hotlink_protection"
	SettingGetResponseIDHTTP2                         SettingGetResponseID = "http2"
	SettingGetResponseIDHTTP3                         SettingGetResponseID = "http3"
	SettingGetResponseIDImageResizing                 SettingGetResponseID = "image_resizing"
	SettingGetResponseIDIPGeolocation                 SettingGetResponseID = "ip_geolocation"
	SettingGetResponseIDIPV6                          SettingGetResponseID = "ipv6"
	SettingGetResponseIDMaxUpload                     SettingGetResponseID = "max_upload"
	SettingGetResponseIDMinTLSVersion                 SettingGetResponseID = "min_tls_version"
	SettingGetResponseIDMirage                        SettingGetResponseID = "mirage"
	SettingGetResponseIDNEL                           SettingGetResponseID = "nel"
	SettingGetResponseIDOpportunisticEncryption       SettingGetResponseID = "opportunistic_encryption"
	SettingGetResponseIDOpportunisticOnion            SettingGetResponseID = "opportunistic_onion"
	SettingGetResponseIDOrangeToOrange                SettingGetResponseID = "orange_to_orange"
	SettingGetResponseIDOriginErrorPagePassThru       SettingGetResponseID = "origin_error_page_pass_thru"
	SettingGetResponseIDPolish                        SettingGetResponseID = "polish"
	SettingGetResponseIDPrefetchPreload               SettingGetResponseID = "prefetch_preload"
	SettingGetResponseIDProxyReadTimeout              SettingGetResponseID = "proxy_read_timeout"
	SettingGetResponseIDPseudoIPV4                    SettingGetResponseID = "pseudo_ipv4"
	SettingGetResponseIDReplaceInsecureJS             SettingGetResponseID = "replace_insecure_js"
	SettingGetResponseIDResponseBuffering             SettingGetResponseID = "response_buffering"
	SettingGetResponseIDRocketLoader                  SettingGetResponseID = "rocket_loader"
	SettingGetResponseIDAutomaticPlatformOptimization SettingGetResponseID = "automatic_platform_optimization"
	SettingGetResponseIDSecurityHeader                SettingGetResponseID = "security_header"
	SettingGetResponseIDSecurityLevel                 SettingGetResponseID = "security_level"
	SettingGetResponseIDServerSideExclude             SettingGetResponseID = "server_side_exclude"
	SettingGetResponseIDSha1Support                   SettingGetResponseID = "sha1_support"
	SettingGetResponseIDSortQueryStringForCache       SettingGetResponseID = "sort_query_string_for_cache"
	SettingGetResponseIDSSL                           SettingGetResponseID = "ssl"
	SettingGetResponseIDSSLRecommender                SettingGetResponseID = "ssl_recommender"
	SettingGetResponseIDTLS1_2Only                    SettingGetResponseID = "tls_1_2_only"
	SettingGetResponseIDTLS1_3                        SettingGetResponseID = "tls_1_3"
	SettingGetResponseIDTLSClientAuth                 SettingGetResponseID = "tls_client_auth"
	SettingGetResponseIDTrueClientIPHeader            SettingGetResponseID = "true_client_ip_header"
	SettingGetResponseIDWAF                           SettingGetResponseID = "waf"
	SettingGetResponseIDWebP                          SettingGetResponseID = "webp"
	SettingGetResponseIDWebsockets                    SettingGetResponseID = "websockets"
)

func (SettingGetResponseID) IsKnown

func (r SettingGetResponseID) IsKnown() bool

type SettingGetResponseUnion

type SettingGetResponseUnion interface {
	// contains filtered or unexported methods
}

0-RTT session resumption enabled for this zone.

Union satisfied by zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.SettingGetResponseZonesSchemasAlwaysUseHTTPS, zones.SettingGetResponseZonesSchemasAutomaticHTTPSRewrites, zones.Brotli, zones.SettingGetResponseZonesSchemasBrowserCacheTTL, zones.SettingGetResponseZonesSchemasBrowserCheck, zones.SettingGetResponseZonesSchemasCacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingGetResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingGetResponseZonesSchemasEdgeCacheTTL, zones.SettingGetResponseZonesSchemasEmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.SettingGetResponseZonesSchemasIPGeolocation, zones.IPV6, zones.SettingGetResponseZonesMaxUpload, zones.MinTLSVersion, zones.SettingGetResponseZonesSchemasMirage, zones.NEL, zones.SettingGetResponseZonesSchemasOpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.SettingGetResponseZonesSchemasOriginErrorPagePassThru, zones.SettingGetResponseZonesSchemasPolish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingGetResponseZonesReplaceInsecureJS, zones.SettingGetResponseZonesSchemasResponseBuffering, zones.SettingGetResponseZonesSchemasRocketLoader, zones.SettingGetResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SettingGetResponseZonesSchemasSecurityLevel, zones.ServerSideExcludes, zones.SettingGetResponseZonesSha1Support, zones.SettingGetResponseZonesSchemasSortQueryStringForCache, zones.SettingGetResponseZonesSchemasSSL, zones.SSLRecommender, zones.SettingGetResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.SettingGetResponseZonesSchemasTrueClientIPHeader, zones.SettingGetResponseZonesSchemasWAF, zones.WebP or zones.Websocket.

type SettingGetResponseZonesCNAMEFlattening

type SettingGetResponseZonesCNAMEFlattening struct {
	// How to flatten the cname destination.
	ID SettingGetResponseZonesCNAMEFlatteningID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesCNAMEFlatteningValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesCNAMEFlatteningEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                  `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesCNAMEFlatteningJSON `json:"-"`
}

Whether or not cname flattening is on.

func (*SettingGetResponseZonesCNAMEFlattening) UnmarshalJSON

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

type SettingGetResponseZonesCNAMEFlatteningEditable

type SettingGetResponseZonesCNAMEFlatteningEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesCNAMEFlatteningEditableTrue  SettingGetResponseZonesCNAMEFlatteningEditable = true
	SettingGetResponseZonesCNAMEFlatteningEditableFalse SettingGetResponseZonesCNAMEFlatteningEditable = false
)

func (SettingGetResponseZonesCNAMEFlatteningEditable) IsKnown

type SettingGetResponseZonesCNAMEFlatteningID

type SettingGetResponseZonesCNAMEFlatteningID string

How to flatten the cname destination.

const (
	SettingGetResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingGetResponseZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingGetResponseZonesCNAMEFlatteningID) IsKnown

type SettingGetResponseZonesCNAMEFlatteningValue

type SettingGetResponseZonesCNAMEFlatteningValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesCNAMEFlatteningValueFlattenAtRoot SettingGetResponseZonesCNAMEFlatteningValue = "flatten_at_root"
	SettingGetResponseZonesCNAMEFlatteningValueFlattenAll    SettingGetResponseZonesCNAMEFlatteningValue = "flatten_all"
)

func (SettingGetResponseZonesCNAMEFlatteningValue) IsKnown

type SettingGetResponseZonesMaxUpload

type SettingGetResponseZonesMaxUpload struct {
	// identifier of the zone setting.
	ID SettingGetResponseZonesMaxUploadID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesMaxUploadValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesMaxUploadEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                            `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesMaxUploadJSON `json:"-"`
}

Maximum size of an allowable upload.

func (*SettingGetResponseZonesMaxUpload) UnmarshalJSON

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

type SettingGetResponseZonesMaxUploadEditable

type SettingGetResponseZonesMaxUploadEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesMaxUploadEditableTrue  SettingGetResponseZonesMaxUploadEditable = true
	SettingGetResponseZonesMaxUploadEditableFalse SettingGetResponseZonesMaxUploadEditable = false
)

func (SettingGetResponseZonesMaxUploadEditable) IsKnown

type SettingGetResponseZonesMaxUploadID

type SettingGetResponseZonesMaxUploadID string

identifier of the zone setting.

const (
	SettingGetResponseZonesMaxUploadIDMaxUpload SettingGetResponseZonesMaxUploadID = "max_upload"
)

func (SettingGetResponseZonesMaxUploadID) IsKnown

type SettingGetResponseZonesMaxUploadValue

type SettingGetResponseZonesMaxUploadValue float64

Current value of the zone setting.

const (
	SettingGetResponseZonesMaxUploadValue100 SettingGetResponseZonesMaxUploadValue = 100
	SettingGetResponseZonesMaxUploadValue200 SettingGetResponseZonesMaxUploadValue = 200
	SettingGetResponseZonesMaxUploadValue500 SettingGetResponseZonesMaxUploadValue = 500
)

func (SettingGetResponseZonesMaxUploadValue) IsKnown

type SettingGetResponseZonesReplaceInsecureJS

type SettingGetResponseZonesReplaceInsecureJS struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesReplaceInsecureJSID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesReplaceInsecureJSValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesReplaceInsecureJSEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                    `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesReplaceInsecureJSJSON `json:"-"`
}

Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io.

func (*SettingGetResponseZonesReplaceInsecureJS) UnmarshalJSON

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

type SettingGetResponseZonesReplaceInsecureJSEditable

type SettingGetResponseZonesReplaceInsecureJSEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesReplaceInsecureJSEditableTrue  SettingGetResponseZonesReplaceInsecureJSEditable = true
	SettingGetResponseZonesReplaceInsecureJSEditableFalse SettingGetResponseZonesReplaceInsecureJSEditable = false
)

func (SettingGetResponseZonesReplaceInsecureJSEditable) IsKnown

type SettingGetResponseZonesReplaceInsecureJSID

type SettingGetResponseZonesReplaceInsecureJSID string

ID of the zone setting.

const (
	SettingGetResponseZonesReplaceInsecureJSIDReplaceInsecureJS SettingGetResponseZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingGetResponseZonesReplaceInsecureJSID) IsKnown

type SettingGetResponseZonesReplaceInsecureJSValue

type SettingGetResponseZonesReplaceInsecureJSValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesReplaceInsecureJSValueOn  SettingGetResponseZonesReplaceInsecureJSValue = "on"
	SettingGetResponseZonesReplaceInsecureJSValueOff SettingGetResponseZonesReplaceInsecureJSValue = "off"
)

func (SettingGetResponseZonesReplaceInsecureJSValue) IsKnown

type SettingGetResponseZonesSchemasAlwaysUseHTTPS

type SettingGetResponseZonesSchemasAlwaysUseHTTPS struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasAlwaysUseHTTPSID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasAlwaysUseHTTPSValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasAlwaysUseHTTPSEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                        `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasAlwaysUseHTTPSJSON `json:"-"`
}

Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.

func (*SettingGetResponseZonesSchemasAlwaysUseHTTPS) UnmarshalJSON

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

type SettingGetResponseZonesSchemasAlwaysUseHTTPSEditable

type SettingGetResponseZonesSchemasAlwaysUseHTTPSEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasAlwaysUseHTTPSEditableTrue  SettingGetResponseZonesSchemasAlwaysUseHTTPSEditable = true
	SettingGetResponseZonesSchemasAlwaysUseHTTPSEditableFalse SettingGetResponseZonesSchemasAlwaysUseHTTPSEditable = false
)

func (SettingGetResponseZonesSchemasAlwaysUseHTTPSEditable) IsKnown

type SettingGetResponseZonesSchemasAlwaysUseHTTPSID

type SettingGetResponseZonesSchemasAlwaysUseHTTPSID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasAlwaysUseHTTPSIDAlwaysUseHTTPS SettingGetResponseZonesSchemasAlwaysUseHTTPSID = "always_use_https"
)

func (SettingGetResponseZonesSchemasAlwaysUseHTTPSID) IsKnown

type SettingGetResponseZonesSchemasAlwaysUseHTTPSValue

type SettingGetResponseZonesSchemasAlwaysUseHTTPSValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasAlwaysUseHTTPSValueOn  SettingGetResponseZonesSchemasAlwaysUseHTTPSValue = "on"
	SettingGetResponseZonesSchemasAlwaysUseHTTPSValueOff SettingGetResponseZonesSchemasAlwaysUseHTTPSValue = "off"
)

func (SettingGetResponseZonesSchemasAlwaysUseHTTPSValue) IsKnown

type SettingGetResponseZonesSchemasAutomaticHTTPSRewrites

type SettingGetResponseZonesSchemasAutomaticHTTPSRewrites struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasAutomaticHTTPSRewritesJSON `json:"-"`
}

Enable the Automatic HTTPS Rewrites feature for this zone.

func (*SettingGetResponseZonesSchemasAutomaticHTTPSRewrites) UnmarshalJSON

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

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditable

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditableTrue  SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditable = true
	SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditableFalse SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditable = false
)

func (SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditable) IsKnown

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasAutomaticHTTPSRewritesIDAutomaticHTTPSRewrites SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

func (SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID) IsKnown

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValueOn  SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue = "on"
	SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValueOff SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue = "off"
)

func (SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue) IsKnown

type SettingGetResponseZonesSchemasAutomaticPlatformOptimization

type SettingGetResponseZonesSchemasAutomaticPlatformOptimization struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID `json:"id,required"`
	// Current value of the zone setting.
	Value AutomaticPlatformOptimization `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                       `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasAutomaticPlatformOptimizationJSON `json:"-"`
}

[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.

func (*SettingGetResponseZonesSchemasAutomaticPlatformOptimization) UnmarshalJSON

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditableTrue  SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable = true
	SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditableFalse SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable = false
)

func (SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown

type SettingGetResponseZonesSchemasBrowserCacheTTL

type SettingGetResponseZonesSchemasBrowserCacheTTL struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasBrowserCacheTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasBrowserCacheTTLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasBrowserCacheTTLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                         `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasBrowserCacheTTLJSON `json:"-"`
}

Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).

func (*SettingGetResponseZonesSchemasBrowserCacheTTL) UnmarshalJSON

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

type SettingGetResponseZonesSchemasBrowserCacheTTLEditable

type SettingGetResponseZonesSchemasBrowserCacheTTLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasBrowserCacheTTLEditableTrue  SettingGetResponseZonesSchemasBrowserCacheTTLEditable = true
	SettingGetResponseZonesSchemasBrowserCacheTTLEditableFalse SettingGetResponseZonesSchemasBrowserCacheTTLEditable = false
)

func (SettingGetResponseZonesSchemasBrowserCacheTTLEditable) IsKnown

type SettingGetResponseZonesSchemasBrowserCacheTTLID

type SettingGetResponseZonesSchemasBrowserCacheTTLID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasBrowserCacheTTLIDBrowserCacheTTL SettingGetResponseZonesSchemasBrowserCacheTTLID = "browser_cache_ttl"
)

func (SettingGetResponseZonesSchemasBrowserCacheTTLID) IsKnown

type SettingGetResponseZonesSchemasBrowserCacheTTLValue

type SettingGetResponseZonesSchemasBrowserCacheTTLValue float64

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasBrowserCacheTTLValue0        SettingGetResponseZonesSchemasBrowserCacheTTLValue = 0
	SettingGetResponseZonesSchemasBrowserCacheTTLValue30       SettingGetResponseZonesSchemasBrowserCacheTTLValue = 30
	SettingGetResponseZonesSchemasBrowserCacheTTLValue60       SettingGetResponseZonesSchemasBrowserCacheTTLValue = 60
	SettingGetResponseZonesSchemasBrowserCacheTTLValue120      SettingGetResponseZonesSchemasBrowserCacheTTLValue = 120
	SettingGetResponseZonesSchemasBrowserCacheTTLValue300      SettingGetResponseZonesSchemasBrowserCacheTTLValue = 300
	SettingGetResponseZonesSchemasBrowserCacheTTLValue1200     SettingGetResponseZonesSchemasBrowserCacheTTLValue = 1200
	SettingGetResponseZonesSchemasBrowserCacheTTLValue1800     SettingGetResponseZonesSchemasBrowserCacheTTLValue = 1800
	SettingGetResponseZonesSchemasBrowserCacheTTLValue3600     SettingGetResponseZonesSchemasBrowserCacheTTLValue = 3600
	SettingGetResponseZonesSchemasBrowserCacheTTLValue7200     SettingGetResponseZonesSchemasBrowserCacheTTLValue = 7200
	SettingGetResponseZonesSchemasBrowserCacheTTLValue10800    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 10800
	SettingGetResponseZonesSchemasBrowserCacheTTLValue14400    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 14400
	SettingGetResponseZonesSchemasBrowserCacheTTLValue18000    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 18000
	SettingGetResponseZonesSchemasBrowserCacheTTLValue28800    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 28800
	SettingGetResponseZonesSchemasBrowserCacheTTLValue43200    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 43200
	SettingGetResponseZonesSchemasBrowserCacheTTLValue57600    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 57600
	SettingGetResponseZonesSchemasBrowserCacheTTLValue72000    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 72000
	SettingGetResponseZonesSchemasBrowserCacheTTLValue86400    SettingGetResponseZonesSchemasBrowserCacheTTLValue = 86400
	SettingGetResponseZonesSchemasBrowserCacheTTLValue172800   SettingGetResponseZonesSchemasBrowserCacheTTLValue = 172800
	SettingGetResponseZonesSchemasBrowserCacheTTLValue259200   SettingGetResponseZonesSchemasBrowserCacheTTLValue = 259200
	SettingGetResponseZonesSchemasBrowserCacheTTLValue345600   SettingGetResponseZonesSchemasBrowserCacheTTLValue = 345600
	SettingGetResponseZonesSchemasBrowserCacheTTLValue432000   SettingGetResponseZonesSchemasBrowserCacheTTLValue = 432000
	SettingGetResponseZonesSchemasBrowserCacheTTLValue691200   SettingGetResponseZonesSchemasBrowserCacheTTLValue = 691200
	SettingGetResponseZonesSchemasBrowserCacheTTLValue1382400  SettingGetResponseZonesSchemasBrowserCacheTTLValue = 1382400
	SettingGetResponseZonesSchemasBrowserCacheTTLValue2073600  SettingGetResponseZonesSchemasBrowserCacheTTLValue = 2073600
	SettingGetResponseZonesSchemasBrowserCacheTTLValue2678400  SettingGetResponseZonesSchemasBrowserCacheTTLValue = 2678400
	SettingGetResponseZonesSchemasBrowserCacheTTLValue5356800  SettingGetResponseZonesSchemasBrowserCacheTTLValue = 5356800
	SettingGetResponseZonesSchemasBrowserCacheTTLValue16070400 SettingGetResponseZonesSchemasBrowserCacheTTLValue = 16070400
	SettingGetResponseZonesSchemasBrowserCacheTTLValue31536000 SettingGetResponseZonesSchemasBrowserCacheTTLValue = 31536000
)

func (SettingGetResponseZonesSchemasBrowserCacheTTLValue) IsKnown

type SettingGetResponseZonesSchemasBrowserCheck

type SettingGetResponseZonesSchemasBrowserCheck struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasBrowserCheckID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasBrowserCheckValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasBrowserCheckEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                      `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasBrowserCheckJSON `json:"-"`
}

Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).

func (*SettingGetResponseZonesSchemasBrowserCheck) UnmarshalJSON

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

type SettingGetResponseZonesSchemasBrowserCheckEditable

type SettingGetResponseZonesSchemasBrowserCheckEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasBrowserCheckEditableTrue  SettingGetResponseZonesSchemasBrowserCheckEditable = true
	SettingGetResponseZonesSchemasBrowserCheckEditableFalse SettingGetResponseZonesSchemasBrowserCheckEditable = false
)

func (SettingGetResponseZonesSchemasBrowserCheckEditable) IsKnown

type SettingGetResponseZonesSchemasBrowserCheckID

type SettingGetResponseZonesSchemasBrowserCheckID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasBrowserCheckIDBrowserCheck SettingGetResponseZonesSchemasBrowserCheckID = "browser_check"
)

func (SettingGetResponseZonesSchemasBrowserCheckID) IsKnown

type SettingGetResponseZonesSchemasBrowserCheckValue

type SettingGetResponseZonesSchemasBrowserCheckValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasBrowserCheckValueOn  SettingGetResponseZonesSchemasBrowserCheckValue = "on"
	SettingGetResponseZonesSchemasBrowserCheckValueOff SettingGetResponseZonesSchemasBrowserCheckValue = "off"
)

func (SettingGetResponseZonesSchemasBrowserCheckValue) IsKnown

type SettingGetResponseZonesSchemasCacheLevel

type SettingGetResponseZonesSchemasCacheLevel struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasCacheLevelID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasCacheLevelValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasCacheLevelEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                    `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasCacheLevelJSON `json:"-"`
}

Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).

func (*SettingGetResponseZonesSchemasCacheLevel) UnmarshalJSON

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

type SettingGetResponseZonesSchemasCacheLevelEditable

type SettingGetResponseZonesSchemasCacheLevelEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasCacheLevelEditableTrue  SettingGetResponseZonesSchemasCacheLevelEditable = true
	SettingGetResponseZonesSchemasCacheLevelEditableFalse SettingGetResponseZonesSchemasCacheLevelEditable = false
)

func (SettingGetResponseZonesSchemasCacheLevelEditable) IsKnown

type SettingGetResponseZonesSchemasCacheLevelID

type SettingGetResponseZonesSchemasCacheLevelID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasCacheLevelIDCacheLevel SettingGetResponseZonesSchemasCacheLevelID = "cache_level"
)

func (SettingGetResponseZonesSchemasCacheLevelID) IsKnown

type SettingGetResponseZonesSchemasCacheLevelValue

type SettingGetResponseZonesSchemasCacheLevelValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasCacheLevelValueAggressive SettingGetResponseZonesSchemasCacheLevelValue = "aggressive"
	SettingGetResponseZonesSchemasCacheLevelValueBasic      SettingGetResponseZonesSchemasCacheLevelValue = "basic"
	SettingGetResponseZonesSchemasCacheLevelValueSimplified SettingGetResponseZonesSchemasCacheLevelValue = "simplified"
)

func (SettingGetResponseZonesSchemasCacheLevelValue) IsKnown

type SettingGetResponseZonesSchemasEdgeCacheTTL

type SettingGetResponseZonesSchemasEdgeCacheTTL struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasEdgeCacheTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasEdgeCacheTTLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasEdgeCacheTTLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                      `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasEdgeCacheTTLJSON `json:"-"`
}

Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.

func (*SettingGetResponseZonesSchemasEdgeCacheTTL) UnmarshalJSON

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

type SettingGetResponseZonesSchemasEdgeCacheTTLEditable

type SettingGetResponseZonesSchemasEdgeCacheTTLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasEdgeCacheTTLEditableTrue  SettingGetResponseZonesSchemasEdgeCacheTTLEditable = true
	SettingGetResponseZonesSchemasEdgeCacheTTLEditableFalse SettingGetResponseZonesSchemasEdgeCacheTTLEditable = false
)

func (SettingGetResponseZonesSchemasEdgeCacheTTLEditable) IsKnown

type SettingGetResponseZonesSchemasEdgeCacheTTLID

type SettingGetResponseZonesSchemasEdgeCacheTTLID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasEdgeCacheTTLIDEdgeCacheTTL SettingGetResponseZonesSchemasEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingGetResponseZonesSchemasEdgeCacheTTLID) IsKnown

type SettingGetResponseZonesSchemasEdgeCacheTTLValue

type SettingGetResponseZonesSchemasEdgeCacheTTLValue float64

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasEdgeCacheTTLValue30     SettingGetResponseZonesSchemasEdgeCacheTTLValue = 30
	SettingGetResponseZonesSchemasEdgeCacheTTLValue60     SettingGetResponseZonesSchemasEdgeCacheTTLValue = 60
	SettingGetResponseZonesSchemasEdgeCacheTTLValue300    SettingGetResponseZonesSchemasEdgeCacheTTLValue = 300
	SettingGetResponseZonesSchemasEdgeCacheTTLValue1200   SettingGetResponseZonesSchemasEdgeCacheTTLValue = 1200
	SettingGetResponseZonesSchemasEdgeCacheTTLValue1800   SettingGetResponseZonesSchemasEdgeCacheTTLValue = 1800
	SettingGetResponseZonesSchemasEdgeCacheTTLValue3600   SettingGetResponseZonesSchemasEdgeCacheTTLValue = 3600
	SettingGetResponseZonesSchemasEdgeCacheTTLValue7200   SettingGetResponseZonesSchemasEdgeCacheTTLValue = 7200
	SettingGetResponseZonesSchemasEdgeCacheTTLValue10800  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 10800
	SettingGetResponseZonesSchemasEdgeCacheTTLValue14400  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 14400
	SettingGetResponseZonesSchemasEdgeCacheTTLValue18000  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 18000
	SettingGetResponseZonesSchemasEdgeCacheTTLValue28800  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 28800
	SettingGetResponseZonesSchemasEdgeCacheTTLValue43200  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 43200
	SettingGetResponseZonesSchemasEdgeCacheTTLValue57600  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 57600
	SettingGetResponseZonesSchemasEdgeCacheTTLValue72000  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 72000
	SettingGetResponseZonesSchemasEdgeCacheTTLValue86400  SettingGetResponseZonesSchemasEdgeCacheTTLValue = 86400
	SettingGetResponseZonesSchemasEdgeCacheTTLValue172800 SettingGetResponseZonesSchemasEdgeCacheTTLValue = 172800
	SettingGetResponseZonesSchemasEdgeCacheTTLValue259200 SettingGetResponseZonesSchemasEdgeCacheTTLValue = 259200
	SettingGetResponseZonesSchemasEdgeCacheTTLValue345600 SettingGetResponseZonesSchemasEdgeCacheTTLValue = 345600
	SettingGetResponseZonesSchemasEdgeCacheTTLValue432000 SettingGetResponseZonesSchemasEdgeCacheTTLValue = 432000
	SettingGetResponseZonesSchemasEdgeCacheTTLValue518400 SettingGetResponseZonesSchemasEdgeCacheTTLValue = 518400
	SettingGetResponseZonesSchemasEdgeCacheTTLValue604800 SettingGetResponseZonesSchemasEdgeCacheTTLValue = 604800
)

func (SettingGetResponseZonesSchemasEdgeCacheTTLValue) IsKnown

type SettingGetResponseZonesSchemasEmailObfuscation

type SettingGetResponseZonesSchemasEmailObfuscation struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasEmailObfuscationID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasEmailObfuscationValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasEmailObfuscationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                          `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasEmailObfuscationJSON `json:"-"`
}

Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).

func (*SettingGetResponseZonesSchemasEmailObfuscation) UnmarshalJSON

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

type SettingGetResponseZonesSchemasEmailObfuscationEditable

type SettingGetResponseZonesSchemasEmailObfuscationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasEmailObfuscationEditableTrue  SettingGetResponseZonesSchemasEmailObfuscationEditable = true
	SettingGetResponseZonesSchemasEmailObfuscationEditableFalse SettingGetResponseZonesSchemasEmailObfuscationEditable = false
)

func (SettingGetResponseZonesSchemasEmailObfuscationEditable) IsKnown

type SettingGetResponseZonesSchemasEmailObfuscationID

type SettingGetResponseZonesSchemasEmailObfuscationID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasEmailObfuscationIDEmailObfuscation SettingGetResponseZonesSchemasEmailObfuscationID = "email_obfuscation"
)

func (SettingGetResponseZonesSchemasEmailObfuscationID) IsKnown

type SettingGetResponseZonesSchemasEmailObfuscationValue

type SettingGetResponseZonesSchemasEmailObfuscationValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasEmailObfuscationValueOn  SettingGetResponseZonesSchemasEmailObfuscationValue = "on"
	SettingGetResponseZonesSchemasEmailObfuscationValueOff SettingGetResponseZonesSchemasEmailObfuscationValue = "off"
)

func (SettingGetResponseZonesSchemasEmailObfuscationValue) IsKnown

type SettingGetResponseZonesSchemasIPGeolocation

type SettingGetResponseZonesSchemasIPGeolocation struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasIPGeolocationID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasIPGeolocationValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasIPGeolocationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                       `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasIPGeolocationJSON `json:"-"`
}

Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).

func (*SettingGetResponseZonesSchemasIPGeolocation) UnmarshalJSON

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

type SettingGetResponseZonesSchemasIPGeolocationEditable

type SettingGetResponseZonesSchemasIPGeolocationEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasIPGeolocationEditableTrue  SettingGetResponseZonesSchemasIPGeolocationEditable = true
	SettingGetResponseZonesSchemasIPGeolocationEditableFalse SettingGetResponseZonesSchemasIPGeolocationEditable = false
)

func (SettingGetResponseZonesSchemasIPGeolocationEditable) IsKnown

type SettingGetResponseZonesSchemasIPGeolocationID

type SettingGetResponseZonesSchemasIPGeolocationID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasIPGeolocationIDIPGeolocation SettingGetResponseZonesSchemasIPGeolocationID = "ip_geolocation"
)

func (SettingGetResponseZonesSchemasIPGeolocationID) IsKnown

type SettingGetResponseZonesSchemasIPGeolocationValue

type SettingGetResponseZonesSchemasIPGeolocationValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasIPGeolocationValueOn  SettingGetResponseZonesSchemasIPGeolocationValue = "on"
	SettingGetResponseZonesSchemasIPGeolocationValueOff SettingGetResponseZonesSchemasIPGeolocationValue = "off"
)

func (SettingGetResponseZonesSchemasIPGeolocationValue) IsKnown

type SettingGetResponseZonesSchemasMirage

type SettingGetResponseZonesSchemasMirage struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasMirageID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasMirageValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasMirageEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasMirageJSON `json:"-"`
}

Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.

func (*SettingGetResponseZonesSchemasMirage) UnmarshalJSON

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

type SettingGetResponseZonesSchemasMirageEditable

type SettingGetResponseZonesSchemasMirageEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasMirageEditableTrue  SettingGetResponseZonesSchemasMirageEditable = true
	SettingGetResponseZonesSchemasMirageEditableFalse SettingGetResponseZonesSchemasMirageEditable = false
)

func (SettingGetResponseZonesSchemasMirageEditable) IsKnown

type SettingGetResponseZonesSchemasMirageID

type SettingGetResponseZonesSchemasMirageID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasMirageIDMirage SettingGetResponseZonesSchemasMirageID = "mirage"
)

func (SettingGetResponseZonesSchemasMirageID) IsKnown

type SettingGetResponseZonesSchemasMirageValue

type SettingGetResponseZonesSchemasMirageValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasMirageValueOn  SettingGetResponseZonesSchemasMirageValue = "on"
	SettingGetResponseZonesSchemasMirageValueOff SettingGetResponseZonesSchemasMirageValue = "off"
)

func (SettingGetResponseZonesSchemasMirageValue) IsKnown

type SettingGetResponseZonesSchemasOpportunisticEncryption

type SettingGetResponseZonesSchemasOpportunisticEncryption struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasOpportunisticEncryptionID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasOpportunisticEncryptionValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasOpportunisticEncryptionEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                 `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasOpportunisticEncryptionJSON `json:"-"`
}

Enables the Opportunistic Encryption feature for a zone.

func (*SettingGetResponseZonesSchemasOpportunisticEncryption) UnmarshalJSON

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

type SettingGetResponseZonesSchemasOpportunisticEncryptionEditable

type SettingGetResponseZonesSchemasOpportunisticEncryptionEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasOpportunisticEncryptionEditableTrue  SettingGetResponseZonesSchemasOpportunisticEncryptionEditable = true
	SettingGetResponseZonesSchemasOpportunisticEncryptionEditableFalse SettingGetResponseZonesSchemasOpportunisticEncryptionEditable = false
)

func (SettingGetResponseZonesSchemasOpportunisticEncryptionEditable) IsKnown

type SettingGetResponseZonesSchemasOpportunisticEncryptionID

type SettingGetResponseZonesSchemasOpportunisticEncryptionID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasOpportunisticEncryptionIDOpportunisticEncryption SettingGetResponseZonesSchemasOpportunisticEncryptionID = "opportunistic_encryption"
)

func (SettingGetResponseZonesSchemasOpportunisticEncryptionID) IsKnown

type SettingGetResponseZonesSchemasOpportunisticEncryptionValue

type SettingGetResponseZonesSchemasOpportunisticEncryptionValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasOpportunisticEncryptionValueOn  SettingGetResponseZonesSchemasOpportunisticEncryptionValue = "on"
	SettingGetResponseZonesSchemasOpportunisticEncryptionValueOff SettingGetResponseZonesSchemasOpportunisticEncryptionValue = "off"
)

func (SettingGetResponseZonesSchemasOpportunisticEncryptionValue) IsKnown

type SettingGetResponseZonesSchemasOriginErrorPagePassThru

type SettingGetResponseZonesSchemasOriginErrorPagePassThru struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasOriginErrorPagePassThruID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasOriginErrorPagePassThruValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasOriginErrorPagePassThruEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                 `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasOriginErrorPagePassThruJSON `json:"-"`
}

Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.

func (*SettingGetResponseZonesSchemasOriginErrorPagePassThru) UnmarshalJSON

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

type SettingGetResponseZonesSchemasOriginErrorPagePassThruEditable

type SettingGetResponseZonesSchemasOriginErrorPagePassThruEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasOriginErrorPagePassThruEditableTrue  SettingGetResponseZonesSchemasOriginErrorPagePassThruEditable = true
	SettingGetResponseZonesSchemasOriginErrorPagePassThruEditableFalse SettingGetResponseZonesSchemasOriginErrorPagePassThruEditable = false
)

func (SettingGetResponseZonesSchemasOriginErrorPagePassThruEditable) IsKnown

type SettingGetResponseZonesSchemasOriginErrorPagePassThruID

type SettingGetResponseZonesSchemasOriginErrorPagePassThruID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasOriginErrorPagePassThruIDOriginErrorPagePassThru SettingGetResponseZonesSchemasOriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

func (SettingGetResponseZonesSchemasOriginErrorPagePassThruID) IsKnown

type SettingGetResponseZonesSchemasOriginErrorPagePassThruValue

type SettingGetResponseZonesSchemasOriginErrorPagePassThruValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasOriginErrorPagePassThruValueOn  SettingGetResponseZonesSchemasOriginErrorPagePassThruValue = "on"
	SettingGetResponseZonesSchemasOriginErrorPagePassThruValueOff SettingGetResponseZonesSchemasOriginErrorPagePassThruValue = "off"
)

func (SettingGetResponseZonesSchemasOriginErrorPagePassThruValue) IsKnown

type SettingGetResponseZonesSchemasPolish

type SettingGetResponseZonesSchemasPolish struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasPolishID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasPolishValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasPolishEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasPolishJSON `json:"-"`
}

Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.

func (*SettingGetResponseZonesSchemasPolish) UnmarshalJSON

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

type SettingGetResponseZonesSchemasPolishEditable

type SettingGetResponseZonesSchemasPolishEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasPolishEditableTrue  SettingGetResponseZonesSchemasPolishEditable = true
	SettingGetResponseZonesSchemasPolishEditableFalse SettingGetResponseZonesSchemasPolishEditable = false
)

func (SettingGetResponseZonesSchemasPolishEditable) IsKnown

type SettingGetResponseZonesSchemasPolishID

type SettingGetResponseZonesSchemasPolishID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasPolishIDPolish SettingGetResponseZonesSchemasPolishID = "polish"
)

func (SettingGetResponseZonesSchemasPolishID) IsKnown

type SettingGetResponseZonesSchemasPolishValue

type SettingGetResponseZonesSchemasPolishValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasPolishValueOff      SettingGetResponseZonesSchemasPolishValue = "off"
	SettingGetResponseZonesSchemasPolishValueLossless SettingGetResponseZonesSchemasPolishValue = "lossless"
	SettingGetResponseZonesSchemasPolishValueLossy    SettingGetResponseZonesSchemasPolishValue = "lossy"
)

func (SettingGetResponseZonesSchemasPolishValue) IsKnown

type SettingGetResponseZonesSchemasResponseBuffering

type SettingGetResponseZonesSchemasResponseBuffering struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasResponseBufferingID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasResponseBufferingValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasResponseBufferingEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                           `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasResponseBufferingJSON `json:"-"`
}

Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.

func (*SettingGetResponseZonesSchemasResponseBuffering) UnmarshalJSON

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

type SettingGetResponseZonesSchemasResponseBufferingEditable

type SettingGetResponseZonesSchemasResponseBufferingEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasResponseBufferingEditableTrue  SettingGetResponseZonesSchemasResponseBufferingEditable = true
	SettingGetResponseZonesSchemasResponseBufferingEditableFalse SettingGetResponseZonesSchemasResponseBufferingEditable = false
)

func (SettingGetResponseZonesSchemasResponseBufferingEditable) IsKnown

type SettingGetResponseZonesSchemasResponseBufferingID

type SettingGetResponseZonesSchemasResponseBufferingID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasResponseBufferingIDResponseBuffering SettingGetResponseZonesSchemasResponseBufferingID = "response_buffering"
)

func (SettingGetResponseZonesSchemasResponseBufferingID) IsKnown

type SettingGetResponseZonesSchemasResponseBufferingValue

type SettingGetResponseZonesSchemasResponseBufferingValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasResponseBufferingValueOn  SettingGetResponseZonesSchemasResponseBufferingValue = "on"
	SettingGetResponseZonesSchemasResponseBufferingValueOff SettingGetResponseZonesSchemasResponseBufferingValue = "off"
)

func (SettingGetResponseZonesSchemasResponseBufferingValue) IsKnown

type SettingGetResponseZonesSchemasRocketLoader

type SettingGetResponseZonesSchemasRocketLoader struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasRocketLoaderID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasRocketLoaderValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasRocketLoaderEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                      `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasRocketLoaderJSON `json:"-"`
}

Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.

func (*SettingGetResponseZonesSchemasRocketLoader) UnmarshalJSON

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

type SettingGetResponseZonesSchemasRocketLoaderEditable

type SettingGetResponseZonesSchemasRocketLoaderEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasRocketLoaderEditableTrue  SettingGetResponseZonesSchemasRocketLoaderEditable = true
	SettingGetResponseZonesSchemasRocketLoaderEditableFalse SettingGetResponseZonesSchemasRocketLoaderEditable = false
)

func (SettingGetResponseZonesSchemasRocketLoaderEditable) IsKnown

type SettingGetResponseZonesSchemasRocketLoaderID

type SettingGetResponseZonesSchemasRocketLoaderID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasRocketLoaderIDRocketLoader SettingGetResponseZonesSchemasRocketLoaderID = "rocket_loader"
)

func (SettingGetResponseZonesSchemasRocketLoaderID) IsKnown

type SettingGetResponseZonesSchemasRocketLoaderValue

type SettingGetResponseZonesSchemasRocketLoaderValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasRocketLoaderValueOn  SettingGetResponseZonesSchemasRocketLoaderValue = "on"
	SettingGetResponseZonesSchemasRocketLoaderValueOff SettingGetResponseZonesSchemasRocketLoaderValue = "off"
)

func (SettingGetResponseZonesSchemasRocketLoaderValue) IsKnown

type SettingGetResponseZonesSchemasSSL

type SettingGetResponseZonesSchemasSSL struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasSSLID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasSSLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasSSLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                             `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasSSLJSON `json:"-"`
}

SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).

func (*SettingGetResponseZonesSchemasSSL) UnmarshalJSON

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

type SettingGetResponseZonesSchemasSSLEditable

type SettingGetResponseZonesSchemasSSLEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasSSLEditableTrue  SettingGetResponseZonesSchemasSSLEditable = true
	SettingGetResponseZonesSchemasSSLEditableFalse SettingGetResponseZonesSchemasSSLEditable = false
)

func (SettingGetResponseZonesSchemasSSLEditable) IsKnown

type SettingGetResponseZonesSchemasSSLID

type SettingGetResponseZonesSchemasSSLID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasSSLIDSSL SettingGetResponseZonesSchemasSSLID = "ssl"
)

func (SettingGetResponseZonesSchemasSSLID) IsKnown

type SettingGetResponseZonesSchemasSSLValue

type SettingGetResponseZonesSchemasSSLValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasSSLValueOff      SettingGetResponseZonesSchemasSSLValue = "off"
	SettingGetResponseZonesSchemasSSLValueFlexible SettingGetResponseZonesSchemasSSLValue = "flexible"
	SettingGetResponseZonesSchemasSSLValueFull     SettingGetResponseZonesSchemasSSLValue = "full"
	SettingGetResponseZonesSchemasSSLValueStrict   SettingGetResponseZonesSchemasSSLValue = "strict"
)

func (SettingGetResponseZonesSchemasSSLValue) IsKnown

type SettingGetResponseZonesSchemasSecurityLevel

type SettingGetResponseZonesSchemasSecurityLevel struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasSecurityLevelID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasSecurityLevelValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasSecurityLevelEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                       `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasSecurityLevelJSON `json:"-"`
}

Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).

func (*SettingGetResponseZonesSchemasSecurityLevel) UnmarshalJSON

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

type SettingGetResponseZonesSchemasSecurityLevelEditable

type SettingGetResponseZonesSchemasSecurityLevelEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasSecurityLevelEditableTrue  SettingGetResponseZonesSchemasSecurityLevelEditable = true
	SettingGetResponseZonesSchemasSecurityLevelEditableFalse SettingGetResponseZonesSchemasSecurityLevelEditable = false
)

func (SettingGetResponseZonesSchemasSecurityLevelEditable) IsKnown

type SettingGetResponseZonesSchemasSecurityLevelID

type SettingGetResponseZonesSchemasSecurityLevelID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasSecurityLevelIDSecurityLevel SettingGetResponseZonesSchemasSecurityLevelID = "security_level"
)

func (SettingGetResponseZonesSchemasSecurityLevelID) IsKnown

type SettingGetResponseZonesSchemasSecurityLevelValue

type SettingGetResponseZonesSchemasSecurityLevelValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasSecurityLevelValueOff            SettingGetResponseZonesSchemasSecurityLevelValue = "off"
	SettingGetResponseZonesSchemasSecurityLevelValueEssentiallyOff SettingGetResponseZonesSchemasSecurityLevelValue = "essentially_off"
	SettingGetResponseZonesSchemasSecurityLevelValueLow            SettingGetResponseZonesSchemasSecurityLevelValue = "low"
	SettingGetResponseZonesSchemasSecurityLevelValueMedium         SettingGetResponseZonesSchemasSecurityLevelValue = "medium"
	SettingGetResponseZonesSchemasSecurityLevelValueHigh           SettingGetResponseZonesSchemasSecurityLevelValue = "high"
	SettingGetResponseZonesSchemasSecurityLevelValueUnderAttack    SettingGetResponseZonesSchemasSecurityLevelValue = "under_attack"
)

func (SettingGetResponseZonesSchemasSecurityLevelValue) IsKnown

type SettingGetResponseZonesSchemasSortQueryStringForCache

type SettingGetResponseZonesSchemasSortQueryStringForCache struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasSortQueryStringForCacheID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasSortQueryStringForCacheValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasSortQueryStringForCacheEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                 `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasSortQueryStringForCacheJSON `json:"-"`
}

Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.

func (*SettingGetResponseZonesSchemasSortQueryStringForCache) UnmarshalJSON

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

type SettingGetResponseZonesSchemasSortQueryStringForCacheEditable

type SettingGetResponseZonesSchemasSortQueryStringForCacheEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasSortQueryStringForCacheEditableTrue  SettingGetResponseZonesSchemasSortQueryStringForCacheEditable = true
	SettingGetResponseZonesSchemasSortQueryStringForCacheEditableFalse SettingGetResponseZonesSchemasSortQueryStringForCacheEditable = false
)

func (SettingGetResponseZonesSchemasSortQueryStringForCacheEditable) IsKnown

type SettingGetResponseZonesSchemasSortQueryStringForCacheID

type SettingGetResponseZonesSchemasSortQueryStringForCacheID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasSortQueryStringForCacheIDSortQueryStringForCache SettingGetResponseZonesSchemasSortQueryStringForCacheID = "sort_query_string_for_cache"
)

func (SettingGetResponseZonesSchemasSortQueryStringForCacheID) IsKnown

type SettingGetResponseZonesSchemasSortQueryStringForCacheValue

type SettingGetResponseZonesSchemasSortQueryStringForCacheValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasSortQueryStringForCacheValueOn  SettingGetResponseZonesSchemasSortQueryStringForCacheValue = "on"
	SettingGetResponseZonesSchemasSortQueryStringForCacheValueOff SettingGetResponseZonesSchemasSortQueryStringForCacheValue = "off"
)

func (SettingGetResponseZonesSchemasSortQueryStringForCacheValue) IsKnown

type SettingGetResponseZonesSchemasTrueClientIPHeader

type SettingGetResponseZonesSchemasTrueClientIPHeader struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasTrueClientIPHeaderID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasTrueClientIPHeaderValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasTrueClientIPHeaderEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                            `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasTrueClientIPHeaderJSON `json:"-"`
}

Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.

func (*SettingGetResponseZonesSchemasTrueClientIPHeader) UnmarshalJSON

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

type SettingGetResponseZonesSchemasTrueClientIPHeaderEditable

type SettingGetResponseZonesSchemasTrueClientIPHeaderEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasTrueClientIPHeaderEditableTrue  SettingGetResponseZonesSchemasTrueClientIPHeaderEditable = true
	SettingGetResponseZonesSchemasTrueClientIPHeaderEditableFalse SettingGetResponseZonesSchemasTrueClientIPHeaderEditable = false
)

func (SettingGetResponseZonesSchemasTrueClientIPHeaderEditable) IsKnown

type SettingGetResponseZonesSchemasTrueClientIPHeaderID

type SettingGetResponseZonesSchemasTrueClientIPHeaderID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasTrueClientIPHeaderIDTrueClientIPHeader SettingGetResponseZonesSchemasTrueClientIPHeaderID = "true_client_ip_header"
)

func (SettingGetResponseZonesSchemasTrueClientIPHeaderID) IsKnown

type SettingGetResponseZonesSchemasTrueClientIPHeaderValue

type SettingGetResponseZonesSchemasTrueClientIPHeaderValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasTrueClientIPHeaderValueOn  SettingGetResponseZonesSchemasTrueClientIPHeaderValue = "on"
	SettingGetResponseZonesSchemasTrueClientIPHeaderValueOff SettingGetResponseZonesSchemasTrueClientIPHeaderValue = "off"
)

func (SettingGetResponseZonesSchemasTrueClientIPHeaderValue) IsKnown

type SettingGetResponseZonesSchemasWAF

type SettingGetResponseZonesSchemasWAF struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasWAFID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSchemasWAFValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSchemasWAFEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                             `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSchemasWAFJSON `json:"-"`
}

The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).

func (*SettingGetResponseZonesSchemasWAF) UnmarshalJSON

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

type SettingGetResponseZonesSchemasWAFEditable

type SettingGetResponseZonesSchemasWAFEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSchemasWAFEditableTrue  SettingGetResponseZonesSchemasWAFEditable = true
	SettingGetResponseZonesSchemasWAFEditableFalse SettingGetResponseZonesSchemasWAFEditable = false
)

func (SettingGetResponseZonesSchemasWAFEditable) IsKnown

type SettingGetResponseZonesSchemasWAFID

type SettingGetResponseZonesSchemasWAFID string

ID of the zone setting.

const (
	SettingGetResponseZonesSchemasWAFIDWAF SettingGetResponseZonesSchemasWAFID = "waf"
)

func (SettingGetResponseZonesSchemasWAFID) IsKnown

type SettingGetResponseZonesSchemasWAFValue

type SettingGetResponseZonesSchemasWAFValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSchemasWAFValueOn  SettingGetResponseZonesSchemasWAFValue = "on"
	SettingGetResponseZonesSchemasWAFValueOff SettingGetResponseZonesSchemasWAFValue = "off"
)

func (SettingGetResponseZonesSchemasWAFValue) IsKnown

type SettingGetResponseZonesSha1Support

type SettingGetResponseZonesSha1Support struct {
	// Zone setting identifier.
	ID SettingGetResponseZonesSha1SupportID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesSha1SupportValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesSha1SupportEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                              `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesSha1SupportJSON `json:"-"`
}

Allow SHA1 support.

func (*SettingGetResponseZonesSha1Support) UnmarshalJSON

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

type SettingGetResponseZonesSha1SupportEditable

type SettingGetResponseZonesSha1SupportEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesSha1SupportEditableTrue  SettingGetResponseZonesSha1SupportEditable = true
	SettingGetResponseZonesSha1SupportEditableFalse SettingGetResponseZonesSha1SupportEditable = false
)

func (SettingGetResponseZonesSha1SupportEditable) IsKnown

type SettingGetResponseZonesSha1SupportID

type SettingGetResponseZonesSha1SupportID string

Zone setting identifier.

const (
	SettingGetResponseZonesSha1SupportIDSha1Support SettingGetResponseZonesSha1SupportID = "sha1_support"
)

func (SettingGetResponseZonesSha1SupportID) IsKnown

type SettingGetResponseZonesSha1SupportValue

type SettingGetResponseZonesSha1SupportValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesSha1SupportValueOff SettingGetResponseZonesSha1SupportValue = "off"
	SettingGetResponseZonesSha1SupportValueOn  SettingGetResponseZonesSha1SupportValue = "on"
)

func (SettingGetResponseZonesSha1SupportValue) IsKnown

type SettingGetResponseZonesTLS1_2Only

type SettingGetResponseZonesTLS1_2Only struct {
	// Zone setting identifier.
	ID SettingGetResponseZonesTLS1_2OnlyID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesTLS1_2OnlyValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesTLS1_2OnlyEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                             `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesTls1_2OnlyJSON `json:"-"`
}

Only allows TLS1.2.

func (*SettingGetResponseZonesTLS1_2Only) UnmarshalJSON

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

type SettingGetResponseZonesTLS1_2OnlyEditable

type SettingGetResponseZonesTLS1_2OnlyEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	SettingGetResponseZonesTLS1_2OnlyEditableTrue  SettingGetResponseZonesTLS1_2OnlyEditable = true
	SettingGetResponseZonesTLS1_2OnlyEditableFalse SettingGetResponseZonesTLS1_2OnlyEditable = false
)

func (SettingGetResponseZonesTLS1_2OnlyEditable) IsKnown

type SettingGetResponseZonesTLS1_2OnlyID

type SettingGetResponseZonesTLS1_2OnlyID string

Zone setting identifier.

const (
	SettingGetResponseZonesTLS1_2OnlyIDTLS1_2Only SettingGetResponseZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingGetResponseZonesTLS1_2OnlyID) IsKnown

type SettingGetResponseZonesTLS1_2OnlyValue

type SettingGetResponseZonesTLS1_2OnlyValue string

Current value of the zone setting.

const (
	SettingGetResponseZonesTLS1_2OnlyValueOff SettingGetResponseZonesTLS1_2OnlyValue = "off"
	SettingGetResponseZonesTLS1_2OnlyValueOn  SettingGetResponseZonesTLS1_2OnlyValue = "on"
)

func (SettingGetResponseZonesTLS1_2OnlyValue) IsKnown

type SettingService

type SettingService struct {
	Options []option.RequestOption
}

SettingService 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 NewSettingService method instead.

func NewSettingService

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

NewSettingService 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 (*SettingService) Edit

func (r *SettingService) Edit(ctx context.Context, settingID string, params SettingEditParams, opts ...option.RequestOption) (res *SettingEditResponse, err error)

Updates a single zone setting by the identifier

func (*SettingService) Get

func (r *SettingService) Get(ctx context.Context, settingID string, query SettingGetParams, opts ...option.RequestOption) (res *SettingGetResponse, err error)

Fetch a single zone setting by name

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type SortQueryStringForCache

type SortQueryStringForCache struct {
	// Turn on or off the reordering of query strings. When query strings have the same
	// structure, caching improves.
	ID SortQueryStringForCacheID `json:"id"`
	// The status of Query String Sort
	Value SortQueryStringForCacheValue `json:"value"`
	JSON  sortQueryStringForCacheJSON  `json:"-"`
}

func (SortQueryStringForCache) ImplementsPageRulesPageRuleAction

func (r SortQueryStringForCache) ImplementsPageRulesPageRuleAction()

func (*SortQueryStringForCache) UnmarshalJSON

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

type SortQueryStringForCacheID

type SortQueryStringForCacheID string

Turn on or off the reordering of query strings. When query strings have the same structure, caching improves.

const (
	SortQueryStringForCacheIDSortQueryStringForCache SortQueryStringForCacheID = "sort_query_string_for_cache"
)

func (SortQueryStringForCacheID) IsKnown

func (r SortQueryStringForCacheID) IsKnown() bool

type SortQueryStringForCacheParam

type SortQueryStringForCacheParam struct {
	// Turn on or off the reordering of query strings. When query strings have the same
	// structure, caching improves.
	ID param.Field[SortQueryStringForCacheID] `json:"id"`
	// The status of Query String Sort
	Value param.Field[SortQueryStringForCacheValue] `json:"value"`
}

func (SortQueryStringForCacheParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r SortQueryStringForCacheParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (SortQueryStringForCacheParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r SortQueryStringForCacheParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (SortQueryStringForCacheParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r SortQueryStringForCacheParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (SortQueryStringForCacheParam) MarshalJSON

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

type SortQueryStringForCacheValue

type SortQueryStringForCacheValue string

The status of Query String Sort

const (
	SortQueryStringForCacheValueOn  SortQueryStringForCacheValue = "on"
	SortQueryStringForCacheValueOff SortQueryStringForCacheValue = "off"
)

func (SortQueryStringForCacheValue) IsKnown

func (r SortQueryStringForCacheValue) IsKnown() bool

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 SubscriptionGetResponseEnvelope

type SubscriptionGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   interface{}           `json:"result,required"`
	// Whether the API call was successful
	Success SubscriptionGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    subscriptionGetResponseEnvelopeJSON    `json:"-"`
}

func (*SubscriptionGetResponseEnvelope) UnmarshalJSON

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

type SubscriptionGetResponseEnvelopeSuccess

type SubscriptionGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	SubscriptionGetResponseEnvelopeSuccessTrue SubscriptionGetResponseEnvelopeSuccess = true
)

func (SubscriptionGetResponseEnvelopeSuccess) IsKnown

type SubscriptionNewParams

type SubscriptionNewParams struct {
	Subscription shared.SubscriptionParam `json:"subscription,required"`
}

func (SubscriptionNewParams) MarshalJSON

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

type SubscriptionNewResponseEnvelope

type SubscriptionNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   interface{}           `json:"result,required"`
	// Whether the API call was successful
	Success SubscriptionNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    subscriptionNewResponseEnvelopeJSON    `json:"-"`
}

func (*SubscriptionNewResponseEnvelope) UnmarshalJSON

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

type SubscriptionNewResponseEnvelopeSuccess

type SubscriptionNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	SubscriptionNewResponseEnvelopeSuccessTrue SubscriptionNewResponseEnvelopeSuccess = true
)

func (SubscriptionNewResponseEnvelopeSuccess) IsKnown

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionService

type SubscriptionService struct {
	Options []option.RequestOption
}

SubscriptionService 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 NewSubscriptionService method instead.

func NewSubscriptionService

func NewSubscriptionService(opts ...option.RequestOption) (r *SubscriptionService)

NewSubscriptionService 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 (*SubscriptionService) Get

func (r *SubscriptionService) Get(ctx context.Context, identifier string, opts ...option.RequestOption) (res *interface{}, err error)

Lists zone subscription details.

func (*SubscriptionService) New

func (r *SubscriptionService) New(ctx context.Context, identifier string, body SubscriptionNewParams, opts ...option.RequestOption) (res *interface{}, err error)

Create a zone subscription, either plan or add-ons.

func (*SubscriptionService) Update

func (r *SubscriptionService) Update(ctx context.Context, identifier string, body SubscriptionUpdateParams, opts ...option.RequestOption) (res *interface{}, err error)

Updates zone subscriptions, either plan or add-ons.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type SubscriptionUpdateParams

type SubscriptionUpdateParams struct {
	Subscription shared.SubscriptionParam `json:"subscription,required"`
}

func (SubscriptionUpdateParams) MarshalJSON

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

type SubscriptionUpdateResponseEnvelope

type SubscriptionUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   interface{}           `json:"result,required"`
	// Whether the API call was successful
	Success SubscriptionUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    subscriptionUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SubscriptionUpdateResponseEnvelope) UnmarshalJSON

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

type SubscriptionUpdateResponseEnvelopeSuccess

type SubscriptionUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	SubscriptionUpdateResponseEnvelopeSuccessTrue SubscriptionUpdateResponseEnvelopeSuccess = true
)

func (SubscriptionUpdateResponseEnvelopeSuccess) IsKnown

type TLS1_3

type TLS1_3 struct {
	// ID of the zone setting.
	ID TLS1_3ID `json:"id,required"`
	// Current value of the zone setting.
	Value TLS1_3Value `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable TLS1_3Editable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time  `json:"modified_on,nullable" format:"date-time"`
	JSON       tls1_3JSON `json:"-"`
}

Enables Crypto TLS 1.3 feature for a zone.

func (*TLS1_3) UnmarshalJSON

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

type TLS1_3Editable

type TLS1_3Editable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	TLS1_3EditableTrue  TLS1_3Editable = true
	TLS1_3EditableFalse TLS1_3Editable = false
)

func (TLS1_3Editable) IsKnown

func (r TLS1_3Editable) IsKnown() bool

type TLS1_3ID

type TLS1_3ID string

ID of the zone setting.

const (
	TLS1_3IDTLS1_3 TLS1_3ID = "tls_1_3"
)

func (TLS1_3ID) IsKnown

func (r TLS1_3ID) IsKnown() bool

type TLS1_3Param

type TLS1_3Param struct {
	// ID of the zone setting.
	ID param.Field[TLS1_3ID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[TLS1_3Value] `json:"value,required"`
}

Enables Crypto TLS 1.3 feature for a zone.

func (TLS1_3Param) MarshalJSON

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

type TLS1_3Value

type TLS1_3Value string

Current value of the zone setting.

const (
	TLS1_3ValueOn  TLS1_3Value = "on"
	TLS1_3ValueOff TLS1_3Value = "off"
	TLS1_3ValueZrt TLS1_3Value = "zrt"
)

func (TLS1_3Value) IsKnown

func (r TLS1_3Value) IsKnown() bool

type TLSClientAuth

type TLSClientAuth struct {
	// ID of the zone setting.
	ID TLSClientAuthID `json:"id,required"`
	// Current value of the zone setting.
	Value TLSClientAuthValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable TLSClientAuthEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time         `json:"modified_on,nullable" format:"date-time"`
	JSON       tlsClientAuthJSON `json:"-"`
}

TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).

func (*TLSClientAuth) UnmarshalJSON

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

type TLSClientAuthEditable

type TLSClientAuthEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	TLSClientAuthEditableTrue  TLSClientAuthEditable = true
	TLSClientAuthEditableFalse TLSClientAuthEditable = false
)

func (TLSClientAuthEditable) IsKnown

func (r TLSClientAuthEditable) IsKnown() bool

type TLSClientAuthID

type TLSClientAuthID string

ID of the zone setting.

const (
	TLSClientAuthIDTLSClientAuth TLSClientAuthID = "tls_client_auth"
)

func (TLSClientAuthID) IsKnown

func (r TLSClientAuthID) IsKnown() bool

type TLSClientAuthParam

type TLSClientAuthParam struct {
	// ID of the zone setting.
	ID param.Field[TLSClientAuthID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[TLSClientAuthValue] `json:"value,required"`
}

TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).

func (TLSClientAuthParam) MarshalJSON

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

type TLSClientAuthValue

type TLSClientAuthValue string

Current value of the zone setting.

const (
	TLSClientAuthValueOn  TLSClientAuthValue = "on"
	TLSClientAuthValueOff TLSClientAuthValue = "off"
)

func (TLSClientAuthValue) IsKnown

func (r TLSClientAuthValue) IsKnown() bool

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

type TrueClientIPHeader

type TrueClientIPHeader struct {
	// Turn on or off the True-Client-IP Header feature of the Cloudflare Network app.
	ID TrueClientIPHeaderID `json:"id"`
	// The status of True Client IP Header.
	Value TrueClientIPHeaderValue `json:"value"`
	JSON  trueClientIPHeaderJSON  `json:"-"`
}

func (TrueClientIPHeader) ImplementsPageRulesPageRuleAction

func (r TrueClientIPHeader) ImplementsPageRulesPageRuleAction()

func (*TrueClientIPHeader) UnmarshalJSON

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

type TrueClientIPHeaderID

type TrueClientIPHeaderID string

Turn on or off the True-Client-IP Header feature of the Cloudflare Network app.

const (
	TrueClientIPHeaderIDTrueClientIPHeader TrueClientIPHeaderID = "true_client_ip_header"
)

func (TrueClientIPHeaderID) IsKnown

func (r TrueClientIPHeaderID) IsKnown() bool

type TrueClientIPHeaderParam

type TrueClientIPHeaderParam struct {
	// Turn on or off the True-Client-IP Header feature of the Cloudflare Network app.
	ID param.Field[TrueClientIPHeaderID] `json:"id"`
	// The status of True Client IP Header.
	Value param.Field[TrueClientIPHeaderValue] `json:"value"`
}

func (TrueClientIPHeaderParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r TrueClientIPHeaderParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (TrueClientIPHeaderParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r TrueClientIPHeaderParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (TrueClientIPHeaderParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r TrueClientIPHeaderParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (TrueClientIPHeaderParam) MarshalJSON

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

type TrueClientIPHeaderValue

type TrueClientIPHeaderValue string

The status of True Client IP Header.

const (
	TrueClientIPHeaderValueOn  TrueClientIPHeaderValue = "on"
	TrueClientIPHeaderValueOff TrueClientIPHeaderValue = "off"
)

func (TrueClientIPHeaderValue) IsKnown

func (r TrueClientIPHeaderValue) IsKnown() bool

type Type

type Type string

A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.

const (
	TypeFull      Type = "full"
	TypePartial   Type = "partial"
	TypeSecondary Type = "secondary"
)

func (Type) IsKnown

func (r Type) IsKnown() bool

type WAF

type WAF struct {
	// Turn on or off
	// [WAF managed rules (previous version, deprecated)](https://developers.cloudflare.com/waf/reference/legacy/old-waf-managed-rules/).
	// You cannot enable or disable individual WAF managed rules via Page Rules.
	ID WAFID `json:"id"`
	// The status of WAF managed rules (previous version).
	Value WAFValue `json:"value"`
	JSON  wafJSON  `json:"-"`
}

func (WAF) ImplementsPageRulesPageRuleAction

func (r WAF) ImplementsPageRulesPageRuleAction()

func (*WAF) UnmarshalJSON

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

type WAFID

type WAFID string

Turn on or off [WAF managed rules (previous version, deprecated)](https://developers.cloudflare.com/waf/reference/legacy/old-waf-managed-rules/). You cannot enable or disable individual WAF managed rules via Page Rules.

const (
	WAFIDWAF WAFID = "waf"
)

func (WAFID) IsKnown

func (r WAFID) IsKnown() bool

type WAFParam

type WAFParam struct {
	// Turn on or off
	// [WAF managed rules (previous version, deprecated)](https://developers.cloudflare.com/waf/reference/legacy/old-waf-managed-rules/).
	// You cannot enable or disable individual WAF managed rules via Page Rules.
	ID param.Field[WAFID] `json:"id"`
	// The status of WAF managed rules (previous version).
	Value param.Field[WAFValue] `json:"value"`
}

func (WAFParam) ImplementsPageRulesPageRuleEditParamsActionUnion

func (r WAFParam) ImplementsPageRulesPageRuleEditParamsActionUnion()

func (WAFParam) ImplementsPageRulesPageRuleNewParamsActionUnion

func (r WAFParam) ImplementsPageRulesPageRuleNewParamsActionUnion()

func (WAFParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion

func (r WAFParam) ImplementsPageRulesPageRuleUpdateParamsActionUnion()

func (WAFParam) MarshalJSON

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

type WAFValue

type WAFValue string

The status of WAF managed rules (previous version).

const (
	WAFValueOn  WAFValue = "on"
	WAFValueOff WAFValue = "off"
)

func (WAFValue) IsKnown

func (r WAFValue) IsKnown() bool

type WebP

type WebP struct {
	// ID of the zone setting.
	ID WebPID `json:"id,required"`
	// Current value of the zone setting.
	Value WebPValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable WebPEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	JSON       WebPJSON  `json:"-"`
}

When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.

func (*WebP) UnmarshalJSON

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

type WebPEditable

type WebPEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	WebPEditableTrue  WebPEditable = true
	WebPEditableFalse WebPEditable = false
)

func (WebPEditable) IsKnown

func (r WebPEditable) IsKnown() bool

type WebPID

type WebPID string

ID of the zone setting.

const (
	WebPIDWebP WebPID = "webp"
)

func (WebPID) IsKnown

func (r WebPID) IsKnown() bool

type WebPJSON

type WebPJSON struct {
	ID         apijson.Field
	Value      apijson.Field
	Editable   apijson.Field
	ModifiedOn apijson.Field

	ExtraFields map[string]apijson.Field
	// contains filtered or unexported fields
}

WebPJSON contains the JSON metadata for the struct WebP

func (WebPJSON) RawJSON

func (r WebPJSON) RawJSON() string

type WebPParam

type WebPParam struct {
	// ID of the zone setting.
	ID param.Field[WebPID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[WebPValue] `json:"value,required"`
}

When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.

func (WebPParam) MarshalJSON

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

type WebPValue

type WebPValue string

Current value of the zone setting.

const (
	WebPValueOff WebPValue = "off"
	WebPValueOn  WebPValue = "on"
)

func (WebPValue) IsKnown

func (r WebPValue) IsKnown() bool

type Websocket

type Websocket struct {
	// ID of the zone setting.
	ID WebsocketID `json:"id,required"`
	// Current value of the zone setting.
	Value WebsocketValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable WebsocketEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time     `json:"modified_on,nullable" format:"date-time"`
	JSON       websocketJSON `json:"-"`
}

WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).

func (*Websocket) UnmarshalJSON

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

type WebsocketEditable

type WebsocketEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	WebsocketEditableTrue  WebsocketEditable = true
	WebsocketEditableFalse WebsocketEditable = false
)

func (WebsocketEditable) IsKnown

func (r WebsocketEditable) IsKnown() bool

type WebsocketID

type WebsocketID string

ID of the zone setting.

const (
	WebsocketIDWebsockets WebsocketID = "websockets"
)

func (WebsocketID) IsKnown

func (r WebsocketID) IsKnown() bool

type WebsocketParam

type WebsocketParam struct {
	// ID of the zone setting.
	ID param.Field[WebsocketID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[WebsocketValue] `json:"value,required"`
}

WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).

func (WebsocketParam) MarshalJSON

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

type WebsocketValue

type WebsocketValue string

Current value of the zone setting.

const (
	WebsocketValueOff WebsocketValue = "off"
	WebsocketValueOn  WebsocketValue = "on"
)

func (WebsocketValue) IsKnown

func (r WebsocketValue) IsKnown() bool

type ZeroRTT

type ZeroRTT struct {
	// ID of the zone setting.
	ID ZeroRTTID `json:"id,required"`
	// Current value of the zone setting.
	Value ZeroRTTValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZeroRTTEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time   `json:"modified_on,nullable" format:"date-time"`
	JSON       zeroRTTJSON `json:"-"`
}

0-RTT session resumption enabled for this zone.

func (*ZeroRTT) UnmarshalJSON

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

type ZeroRTTEditable

type ZeroRTTEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

const (
	ZeroRTTEditableTrue  ZeroRTTEditable = true
	ZeroRTTEditableFalse ZeroRTTEditable = false
)

func (ZeroRTTEditable) IsKnown

func (r ZeroRTTEditable) IsKnown() bool

type ZeroRTTID

type ZeroRTTID string

ID of the zone setting.

const (
	ZeroRTTID0rtt ZeroRTTID = "0rtt"
)

func (ZeroRTTID) IsKnown

func (r ZeroRTTID) IsKnown() bool

type ZeroRTTParam

type ZeroRTTParam struct {
	// ID of the zone setting.
	ID param.Field[ZeroRTTID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZeroRTTValue] `json:"value,required"`
}

0-RTT session resumption enabled for this zone.

func (ZeroRTTParam) MarshalJSON

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

type ZeroRTTValue

type ZeroRTTValue string

Current value of the zone setting.

const (
	ZeroRTTValueOn  ZeroRTTValue = "on"
	ZeroRTTValueOff ZeroRTTValue = "off"
)

func (ZeroRTTValue) IsKnown

func (r ZeroRTTValue) IsKnown() bool

type Zone

type Zone struct {
	// Identifier
	ID string `json:"id,required"`
	// The account the zone belongs to
	Account ZoneAccount `json:"account,required"`
	// The last time proof of ownership was detected and the zone was made active
	ActivatedOn time.Time `json:"activated_on,required,nullable" format:"date-time"`
	// When the zone was created
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// The interval (in seconds) from when development mode expires (positive integer)
	// or last expired (negative integer) for the domain. If development mode has never
	// been enabled, this value is 0.
	DevelopmentMode float64 `json:"development_mode,required"`
	// Metadata about the zone
	Meta ZoneMeta `json:"meta,required"`
	// When the zone was last modified
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// The domain name
	Name string `json:"name,required"`
	// The name servers Cloudflare assigns to a zone
	NameServers []string `json:"name_servers,required" format:"hostname"`
	// DNS host at the time of switching to Cloudflare
	OriginalDnshost string `json:"original_dnshost,required,nullable"`
	// Original name servers before moving to Cloudflare
	OriginalNameServers []string `json:"original_name_servers,required,nullable" format:"hostname"`
	// Registrar for the domain at the time of switching to Cloudflare
	OriginalRegistrar string `json:"original_registrar,required,nullable"`
	// The owner of the zone
	Owner ZoneOwner `json:"owner,required"`
	// Indicates whether the zone is only using Cloudflare DNS services. A true value
	// means the zone will not receive security or performance benefits.
	Paused bool `json:"paused"`
	// The zone status on Cloudflare.
	Status ZoneStatus `json:"status"`
	// A full zone implies that DNS is hosted with Cloudflare. A partial zone is
	// typically a partner-hosted zone or a CNAME setup.
	Type Type `json:"type"`
	// An array of domains used for custom name servers. This is only available for
	// Business and Enterprise plans.
	VanityNameServers []string `json:"vanity_name_servers" format:"hostname"`
	JSON              zoneJSON `json:"-"`
}

func (*Zone) UnmarshalJSON

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

type ZoneAccount

type ZoneAccount struct {
	// Identifier
	ID string `json:"id"`
	// The name of the account
	Name string          `json:"name"`
	JSON zoneAccountJSON `json:"-"`
}

The account the zone belongs to

func (*ZoneAccount) UnmarshalJSON

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

type ZoneDeleteParams

type ZoneDeleteParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ZoneDeleteResponse

type ZoneDeleteResponse struct {
	// Identifier
	ID   string                 `json:"id,required"`
	JSON zoneDeleteResponseJSON `json:"-"`
}

func (*ZoneDeleteResponse) UnmarshalJSON

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

type ZoneDeleteResponseEnvelope

type ZoneDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success bool                           `json:"success,required"`
	Result  ZoneDeleteResponse             `json:"result,nullable"`
	JSON    zoneDeleteResponseEnvelopeJSON `json:"-"`
}

func (*ZoneDeleteResponseEnvelope) UnmarshalJSON

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

type ZoneEditParams

type ZoneEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// A full zone implies that DNS is hosted with Cloudflare. A partial zone is
	// typically a partner-hosted zone or a CNAME setup. This parameter is only
	// available to Enterprise customers or if it has been explicitly enabled on a
	// zone.
	Type param.Field[ZoneEditParamsType] `json:"type"`
	// An array of domains used for custom name servers. This is only available for
	// Business and Enterprise plans.
	VanityNameServers param.Field[[]string] `json:"vanity_name_servers" format:"hostname"`
}

func (ZoneEditParams) MarshalJSON

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

type ZoneEditParamsType

type ZoneEditParamsType string

A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone.

const (
	ZoneEditParamsTypeFull      ZoneEditParamsType = "full"
	ZoneEditParamsTypePartial   ZoneEditParamsType = "partial"
	ZoneEditParamsTypeSecondary ZoneEditParamsType = "secondary"
)

func (ZoneEditParamsType) IsKnown

func (r ZoneEditParamsType) IsKnown() bool

type ZoneEditResponseEnvelope

type ZoneEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success bool                         `json:"success,required"`
	Result  Zone                         `json:"result"`
	JSON    zoneEditResponseEnvelopeJSON `json:"-"`
}

func (*ZoneEditResponseEnvelope) UnmarshalJSON

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

type ZoneGetParams

type ZoneGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ZoneGetResponseEnvelope

type ZoneGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success bool                        `json:"success,required"`
	Result  Zone                        `json:"result"`
	JSON    zoneGetResponseEnvelopeJSON `json:"-"`
}

func (*ZoneGetResponseEnvelope) UnmarshalJSON

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

type ZoneHold

type ZoneHold struct {
	Hold              bool         `json:"hold"`
	HoldAfter         string       `json:"hold_after"`
	IncludeSubdomains string       `json:"include_subdomains"`
	JSON              zoneHoldJSON `json:"-"`
}

func (*ZoneHold) UnmarshalJSON

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

type ZoneListParams

type ZoneListParams struct {
	Account param.Field[ZoneListParamsAccount] `query:"account"`
	// Direction to order zones.
	Direction param.Field[ZoneListParamsDirection] `query:"direction"`
	// Whether to match all search requirements or at least one (any).
	Match param.Field[ZoneListParamsMatch] `query:"match"`
	// A domain name. Optional filter operators can be provided to extend refine the
	// search:
	//
	// - `equal` (default)
	// - `not_equal`
	// - `starts_with`
	// - `ends_with`
	// - `contains`
	// - `starts_with_case_sensitive`
	// - `ends_with_case_sensitive`
	// - `contains_case_sensitive`
	Name param.Field[string] `query:"name"`
	// Field to order zones by.
	Order param.Field[ZoneListParamsOrder] `query:"order"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of zones per page.
	PerPage param.Field[float64] `query:"per_page"`
	// A zone status
	Status param.Field[ZoneListParamsStatus] `query:"status"`
}

func (ZoneListParams) URLQuery

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

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

type ZoneListParamsAccount

type ZoneListParamsAccount struct {
	// An account ID
	ID param.Field[string] `query:"id"`
	// An account Name. Optional filter operators can be provided to extend refine the
	// search:
	//
	// - `equal` (default)
	// - `not_equal`
	// - `starts_with`
	// - `ends_with`
	// - `contains`
	// - `starts_with_case_sensitive`
	// - `ends_with_case_sensitive`
	// - `contains_case_sensitive`
	Name param.Field[string] `query:"name"`
}

func (ZoneListParamsAccount) URLQuery

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

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

type ZoneListParamsDirection

type ZoneListParamsDirection string

Direction to order zones.

const (
	ZoneListParamsDirectionAsc  ZoneListParamsDirection = "asc"
	ZoneListParamsDirectionDesc ZoneListParamsDirection = "desc"
)

func (ZoneListParamsDirection) IsKnown

func (r ZoneListParamsDirection) IsKnown() bool

type ZoneListParamsMatch

type ZoneListParamsMatch string

Whether to match all search requirements or at least one (any).

const (
	ZoneListParamsMatchAny ZoneListParamsMatch = "any"
	ZoneListParamsMatchAll ZoneListParamsMatch = "all"
)

func (ZoneListParamsMatch) IsKnown

func (r ZoneListParamsMatch) IsKnown() bool

type ZoneListParamsOrder

type ZoneListParamsOrder string

Field to order zones by.

const (
	ZoneListParamsOrderName        ZoneListParamsOrder = "name"
	ZoneListParamsOrderStatus      ZoneListParamsOrder = "status"
	ZoneListParamsOrderAccountID   ZoneListParamsOrder = "account.id"
	ZoneListParamsOrderAccountName ZoneListParamsOrder = "account.name"
)

func (ZoneListParamsOrder) IsKnown

func (r ZoneListParamsOrder) IsKnown() bool

type ZoneListParamsStatus

type ZoneListParamsStatus string

A zone status

const (
	ZoneListParamsStatusInitializing ZoneListParamsStatus = "initializing"
	ZoneListParamsStatusPending      ZoneListParamsStatus = "pending"
	ZoneListParamsStatusActive       ZoneListParamsStatus = "active"
	ZoneListParamsStatusMoved        ZoneListParamsStatus = "moved"
)

func (ZoneListParamsStatus) IsKnown

func (r ZoneListParamsStatus) IsKnown() bool

type ZoneMeta

type ZoneMeta struct {
	// The zone is only configured for CDN
	CDNOnly bool `json:"cdn_only"`
	// Number of Custom Certificates the zone can have
	CustomCertificateQuota int64 `json:"custom_certificate_quota"`
	// The zone is only configured for DNS
	DNSOnly bool `json:"dns_only"`
	// The zone is setup with Foundation DNS
	FoundationDNS bool `json:"foundation_dns"`
	// Number of Page Rules a zone can have
	PageRuleQuota int64 `json:"page_rule_quota"`
	// The zone has been flagged for phishing
	PhishingDetected bool         `json:"phishing_detected"`
	Step             int64        `json:"step"`
	JSON             zoneMetaJSON `json:"-"`
}

Metadata about the zone

func (*ZoneMeta) UnmarshalJSON

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

type ZoneNewParams

type ZoneNewParams struct {
	Account param.Field[ZoneNewParamsAccount] `json:"account,required"`
	// The domain name
	Name param.Field[string] `json:"name,required"`
	// A full zone implies that DNS is hosted with Cloudflare. A partial zone is
	// typically a partner-hosted zone or a CNAME setup.
	Type param.Field[Type] `json:"type"`
}

func (ZoneNewParams) MarshalJSON

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

type ZoneNewParamsAccount

type ZoneNewParamsAccount struct {
	// Identifier
	ID param.Field[string] `json:"id"`
}

func (ZoneNewParamsAccount) MarshalJSON

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

type ZoneNewResponseEnvelope

type ZoneNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success bool                        `json:"success,required"`
	Result  Zone                        `json:"result"`
	JSON    zoneNewResponseEnvelopeJSON `json:"-"`
}

func (*ZoneNewResponseEnvelope) UnmarshalJSON

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

type ZoneOwner

type ZoneOwner struct {
	// Identifier
	ID string `json:"id"`
	// Name of the owner
	Name string `json:"name"`
	// The type of owner
	Type string        `json:"type"`
	JSON zoneOwnerJSON `json:"-"`
}

The owner of the zone

func (*ZoneOwner) UnmarshalJSON

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

type ZoneService

type ZoneService struct {
	Options           []option.RequestOption
	ActivationCheck   *ActivationCheckService
	Settings          *SettingService
	CustomNameservers *CustomNameserverService
	Holds             *HoldService
	Subscriptions     *SubscriptionService
	Plans             *PlanService
	RatePlans         *RatePlanService
}

ZoneService 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 NewZoneService method instead.

func NewZoneService

func NewZoneService(opts ...option.RequestOption) (r *ZoneService)

NewZoneService 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 (*ZoneService) Delete

func (r *ZoneService) Delete(ctx context.Context, body ZoneDeleteParams, opts ...option.RequestOption) (res *ZoneDeleteResponse, err error)

Deletes an existing zone.

func (*ZoneService) Edit

func (r *ZoneService) Edit(ctx context.Context, params ZoneEditParams, opts ...option.RequestOption) (res *Zone, err error)

Edits a zone. Only one zone property can be changed at a time.

func (*ZoneService) Get

func (r *ZoneService) Get(ctx context.Context, query ZoneGetParams, opts ...option.RequestOption) (res *Zone, err error)

Zone Details

func (*ZoneService) List

Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed.

func (*ZoneService) ListAutoPaging

Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed.

func (*ZoneService) New

func (r *ZoneService) New(ctx context.Context, body ZoneNewParams, opts ...option.RequestOption) (res *Zone, err error)

Create Zone

type ZoneStatus

type ZoneStatus string

The zone status on Cloudflare.

const (
	ZoneStatusInitializing ZoneStatus = "initializing"
	ZoneStatusPending      ZoneStatus = "pending"
	ZoneStatusActive       ZoneStatus = "active"
	ZoneStatusMoved        ZoneStatus = "moved"
)

func (ZoneStatus) IsKnown

func (r ZoneStatus) IsKnown() bool

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL