zones

package
v5.1.0 Latest Latest
Warning

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

 Go to latest Published: Aug 14, 2025 License: Apache-2.0 Imports: 16 Imported by: 3

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type 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 

func (r *ActivationCheckService) Trigger(ctx context.Context, body ActivationCheckTriggerParams, opts ...option.RequestOption) (res *ActivationCheckTriggerResponse, err error)

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   []ActivationCheckTriggerResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ActivationCheckTriggerResponseEnvelopeMessages `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 ActivationCheckTriggerResponseEnvelopeErrors 

type ActivationCheckTriggerResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ActivationCheckTriggerResponseEnvelopeErrorsSource `json:"source"`
	JSON             activationCheckTriggerResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ActivationCheckTriggerResponseEnvelopeErrors) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeErrorsSource 

type ActivationCheckTriggerResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    activationCheckTriggerResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ActivationCheckTriggerResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeMessages 

type ActivationCheckTriggerResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           ActivationCheckTriggerResponseEnvelopeMessagesSource `json:"source"`
	JSON             activationCheckTriggerResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ActivationCheckTriggerResponseEnvelopeMessages) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeMessagesSource 

type ActivationCheckTriggerResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    activationCheckTriggerResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ActivationCheckTriggerResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeSuccess 

type ActivationCheckTriggerResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	ActivationCheckTriggerResponseEnvelopeSuccessTrue ActivationCheckTriggerResponseEnvelopeSuccess = true
)

func (ActivationCheckTriggerResponseEnvelopeSuccess) IsKnown 

func (r ActivationCheckTriggerResponseEnvelopeSuccess) IsKnown() bool

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

func (r AlwaysUseHTTPS) ImplementsPageRuleAction()

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

func (r AlwaysUseHTTPSParam) ImplementsPageRuleEditParamsActionUnion()

func (AlwaysUseHTTPSParam) ImplementsPageRuleNewParamsActionUnion 

func (r AlwaysUseHTTPSParam) ImplementsPageRuleNewParamsActionUnion()

func (AlwaysUseHTTPSParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r AlwaysUseHTTPSParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r AutomaticHTTPSRewrites) ImplementsPageRuleAction()

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

func (r AutomaticHTTPSRewritesParam) ImplementsPageRuleEditParamsActionUnion()

func (AutomaticHTTPSRewritesParam) ImplementsPageRuleNewParamsActionUnion 

func (r AutomaticHTTPSRewritesParam) ImplementsPageRuleNewParamsActionUnion()

func (AutomaticHTTPSRewritesParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r AutomaticHTTPSRewritesParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r AutomaticPlatformOptimizationParam) ImplementsSettingEditParamsBodyValueValueUnion()

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 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. Minimum values by plan:
	//
	//   - Free: 7200 seconds (2 hours)
	//   - Pro: 3600 seconds (1 hour)
	//   - Business: 1 second
	//   - Enterprise: 1 second Setting this to 0 enables "Respect Existing Headers" and
	//     is allowed for all plans.
	Value int64               `json:"value"`
	JSON  browserCacheTTLJSON `json:"-"`
}

func (BrowserCacheTTL) ImplementsPageRuleAction 

func (r BrowserCacheTTL) ImplementsPageRuleAction()

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. Minimum values by plan:
	//
	//   - Free: 7200 seconds (2 hours)
	//   - Pro: 3600 seconds (1 hour)
	//   - Business: 1 second
	//   - Enterprise: 1 second Setting this to 0 enables "Respect Existing Headers" and
	//     is allowed for all plans.
	Value param.Field[int64] `json:"value"`
}

func (BrowserCacheTTLParam) ImplementsPageRuleEditParamsActionUnion 

func (r BrowserCacheTTLParam) ImplementsPageRuleEditParamsActionUnion()

func (BrowserCacheTTLParam) ImplementsPageRuleNewParamsActionUnion 

func (r BrowserCacheTTLParam) ImplementsPageRuleNewParamsActionUnion()

func (BrowserCacheTTLParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r BrowserCacheTTLParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r BrowserCheck) ImplementsPageRuleAction()

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

func (r BrowserCheckParam) ImplementsPageRuleEditParamsActionUnion()

func (BrowserCheckParam) ImplementsPageRuleNewParamsActionUnion 

func (r BrowserCheckParam) ImplementsPageRuleNewParamsActionUnion()

func (BrowserCheckParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r BrowserCheckParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r CacheLevel) ImplementsPageRuleAction()

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

func (r CacheLevelParam) ImplementsPageRuleEditParamsActionUnion()

func (CacheLevelParam) ImplementsPageRuleNewParamsActionUnion 

func (r CacheLevelParam) ImplementsPageRuleNewParamsActionUnion()

func (CacheLevelParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r CacheLevelParam) ImplementsPageRuleUpdateParamsActionUnion()

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

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc added in v5.1.0 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type CustomNameserverGetParams 

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

type CustomNameserverGetResponse 

type CustomNameserverGetResponse struct {
	Errors   []CustomNameserverGetResponseError   `json:"errors,required"`
	Messages []CustomNameserverGetResponseMessage `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 CustomNameserverGetResponseError added in v5.1.0 

type CustomNameserverGetResponseError struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           CustomNameserverGetResponseErrorsSource `json:"source"`
	JSON             customNameserverGetResponseErrorJSON    `json:"-"`
}

func (*CustomNameserverGetResponseError) UnmarshalJSON added in v5.1.0 

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

type CustomNameserverGetResponseErrorsSource added in v5.1.0 

type CustomNameserverGetResponseErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    customNameserverGetResponseErrorsSourceJSON `json:"-"`
}

func (*CustomNameserverGetResponseErrorsSource) UnmarshalJSON added in v5.1.0 

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

type CustomNameserverGetResponseMessage added in v5.1.0 

type CustomNameserverGetResponseMessage struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           CustomNameserverGetResponseMessagesSource `json:"source"`
	JSON             customNameserverGetResponseMessageJSON    `json:"-"`
}

func (*CustomNameserverGetResponseMessage) UnmarshalJSON added in v5.1.0 

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

type CustomNameserverGetResponseMessagesSource added in v5.1.0 

type CustomNameserverGetResponseMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    customNameserverGetResponseMessagesSourceJSON `json:"-"`
}

func (*CustomNameserverGetResponseMessagesSource) UnmarshalJSON added in v5.1.0 

func (r *CustomNameserverGetResponseMessagesSource) 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 

func (r CustomNameserverGetResponseSuccess) IsKnown() bool

type CustomNameserverService deprecated 

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.

Deprecated: Use DNS settings API 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 deprecated 

func (r *CustomNameserverService) Get(ctx context.Context, query CustomNameserverGetParams, opts ...option.RequestOption) (res *CustomNameserverGetResponse, err error)

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

Deprecated: Use [DNS settings API](https://developers.cloudflare.com/api/resources/dns/subresources/settings/methods/get/) instead.

func (*CustomNameserverService) Update deprecated 

func (r *CustomNameserverService) Update(ctx context.Context, params CustomNameserverUpdateParams, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)

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

Deprecated: Use [DNS settings API](https://developers.cloudflare.com/api/resources/dns/subresources/settings/methods/put/) instead.

func (*CustomNameserverService) UpdateAutoPaging deprecated 

func (r *CustomNameserverService) UpdateAutoPaging(ctx context.Context, params CustomNameserverUpdateParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]

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

Deprecated: Use [DNS settings API](https://developers.cloudflare.com/api/resources/dns/subresources/settings/methods/put/) instead.

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

func (r EmailObfuscation) ImplementsPageRuleAction()

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

func (r EmailObfuscationParam) ImplementsPageRuleEditParamsActionUnion()

func (EmailObfuscationParam) ImplementsPageRuleNewParamsActionUnion 

func (r EmailObfuscationParam) ImplementsPageRuleNewParamsActionUnion()

func (EmailObfuscationParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r EmailObfuscationParam) ImplementsPageRuleUpdateParamsActionUnion()

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 ErrorDataSource 

type ErrorDataSource = shared.ErrorDataSource

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

func (r HoldDeleteResponseEnvelopeSuccess) IsKnown() bool

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 

func (r HoldEditResponseEnvelopeSuccess) IsKnown() bool

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 

func (r HoldGetResponseEnvelopeSuccess) IsKnown() bool

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 

func (r HoldNewResponseEnvelopeSuccess) IsKnown() bool

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

func (r IPGeolocation) ImplementsPageRuleAction()

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

func (r IPGeolocationParam) ImplementsPageRuleEditParamsActionUnion()

func (IPGeolocationParam) ImplementsPageRuleNewParamsActionUnion 

func (r IPGeolocationParam) ImplementsPageRuleNewParamsActionUnion()

func (IPGeolocationParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r IPGeolocationParam) ImplementsPageRuleUpdateParamsActionUnion()

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 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 Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations 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 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 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) ImplementsPageRuleAction 

func (r Mirage) ImplementsPageRuleAction()

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

func (r MirageParam) ImplementsPageRuleEditParamsActionUnion()

func (MirageParam) ImplementsPageRuleNewParamsActionUnion 

func (r MirageParam) ImplementsPageRuleNewParamsActionUnion()

func (MirageParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r MirageParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r OpportunisticEncryption) ImplementsPageRuleAction()

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

func (r OpportunisticEncryptionParam) ImplementsPageRuleEditParamsActionUnion()

func (OpportunisticEncryptionParam) ImplementsPageRuleNewParamsActionUnion 

func (r OpportunisticEncryptionParam) ImplementsPageRuleNewParamsActionUnion()

func (OpportunisticEncryptionParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r OpportunisticEncryptionParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r OriginErrorPagePassThru) ImplementsPageRuleAction()

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

func (r OriginErrorPagePassThruParam) ImplementsPageRuleEditParamsActionUnion()

func (OriginErrorPagePassThruParam) ImplementsPageRuleNewParamsActionUnion 

func (r OriginErrorPagePassThruParam) ImplementsPageRuleNewParamsActionUnion()

func (OriginErrorPagePassThruParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r OriginErrorPagePassThruParam) ImplementsPageRuleUpdateParamsActionUnion()

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 

func (r PlanGetResponseEnvelopeSuccess) IsKnown() bool

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 

func (r *PlanService) List(ctx context.Context, query PlanListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AvailableRatePlan], err error)

Lists available plans the zone can subscribe to.

func (*PlanService) ListAutoPaging 

func (r *PlanService) ListAutoPaging(ctx context.Context, query PlanListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AvailableRatePlan]

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

func (r Polish) ImplementsPageRuleAction()

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

func (r PolishParam) ImplementsPageRuleEditParamsActionUnion()

func (PolishParam) ImplementsPageRuleNewParamsActionUnion 

func (r PolishParam) ImplementsPageRuleNewParamsActionUnion()

func (PolishParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r PolishParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r RatePlanGetResponseComponentsName) IsKnown() bool

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 RatePlanID 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type 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 

func (r *RatePlanService) Get(ctx context.Context, query RatePlanGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[RatePlanGetResponse], err error)

Lists all rate plans the zone can subscribe to.

func (*RatePlanService) GetAutoPaging 

func (r *RatePlanService) GetAutoPaging(ctx context.Context, query RatePlanGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RatePlanGetResponse]

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

func (r ResponseBuffering) ImplementsPageRuleAction()

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

func (r ResponseBufferingParam) ImplementsPageRuleEditParamsActionUnion()

func (ResponseBufferingParam) ImplementsPageRuleNewParamsActionUnion 

func (r ResponseBufferingParam) ImplementsPageRuleNewParamsActionUnion()

func (ResponseBufferingParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r ResponseBufferingParam) ImplementsPageRuleUpdateParamsActionUnion()

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 ResponseInfoSource 

type ResponseInfoSource = shared.ResponseInfoSource

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

func (r RocketLoader) ImplementsPageRuleAction()

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

func (r RocketLoaderParam) ImplementsPageRuleEditParamsActionUnion()

func (RocketLoaderParam) ImplementsPageRuleNewParamsActionUnion 

func (r RocketLoaderParam) ImplementsPageRuleNewParamsActionUnion()

func (RocketLoaderParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r RocketLoaderParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r SSL) ImplementsPageRuleAction()

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

func (r SSLParam) ImplementsPageRuleEditParamsActionUnion()

func (SSLParam) ImplementsPageRuleNewParamsActionUnion 

func (r SSLParam) ImplementsPageRuleNewParamsActionUnion()

func (SSLParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r SSLParam) ImplementsPageRuleUpdateParamsActionUnion()

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

func (r SecurityLevel) ImplementsPageRuleAction()

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

func (r SecurityLevelParam) ImplementsPageRuleEditParamsActionUnion()

func (SecurityLevelParam) ImplementsPageRuleNewParamsActionUnion 

func (r SecurityLevelParam) ImplementsPageRuleNewParamsActionUnion()

func (SecurityLevelParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r SecurityLevelParam) ImplementsPageRuleUpdateParamsActionUnion()

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 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"`
	Body   SettingEditParamsBodyUnion `json:"body,required"`
}

func (SettingEditParams) MarshalJSON 

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

type SettingEditParamsBody 

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

func (SettingEditParamsBody) MarshalJSON 

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

type SettingEditParamsBodyEnabled 

type SettingEditParamsBodyEnabled struct {
	// ssl-recommender enrollment setting.
	Enabled param.Field[bool] `json:"enabled"`
}

func (SettingEditParamsBodyEnabled) MarshalJSON 

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

type SettingEditParamsBodyUnion 

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

Satisfied by zones.SettingEditParamsBodyEnabled, zones.SettingEditParamsBodyValue, SettingEditParamsBody.

type SettingEditParamsBodyValue 

type SettingEditParamsBodyValue struct {
	// Value of the zone setting.
	Value param.Field[SettingEditParamsBodyValueValueUnion] `json:"value"`
}

func (SettingEditParamsBodyValue) MarshalJSON 

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

type SettingEditParamsBodyValueValue 

type SettingEditParamsBodyValueValue 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"`
	// Indicates whether or not Cloudflare proxy is enabled.
	Cf param.Field[bool] `json:"cf"`
	// Whether the feature is enabled or not.
	Enabled   param.Field[bool]        `json:"enabled"`
	Hostnames param.Field[interface{}] `json:"hostnames"`
	// Egress pool id which refers to a grouping of dedicated egress IPs through which
	// Cloudflare will connect to origin.
	PoolID                  param.Field[string]      `json:"pool_id"`
	StrictTransportSecurity param.Field[interface{}] `json:"strict_transport_security"`
	// Indicates whether or not site is powered by WordPress.
	Wordpress param.Field[bool] `json:"wordpress"`
	// Indicates whether or not
	// [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is
	// installed.
	WpPlugin param.Field[bool] `json:"wp_plugin"`
}

Value of the zone setting.

func (SettingEditParamsBodyValueValue) ImplementsSettingEditParamsBodyValueValueUnion 

func (r SettingEditParamsBodyValueValue) ImplementsSettingEditParamsBodyValueValueUnion()

func (SettingEditParamsBodyValueValue) MarshalJSON 

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

type SettingEditParamsBodyValueValueUnion 

type SettingEditParamsBodyValueValueUnion interface {
	ImplementsSettingEditParamsBodyValueValueUnion()
}

Value of the zone setting.

Satisfied by zones.SettingEditParamsBodyValueValueZonesCacheRulesAegisValue, zones.SettingEditParamsBodyValueValueZonesCiphersValue, zones.SettingEditParamsBodyValueValueZonesNELValue, shared.UnionFloat, zones.AutomaticPlatformOptimizationParam, zones.SettingEditParamsBodyValueValueZonesSecurityHeaderValue, SettingEditParamsBodyValueValue.

Use [Raw()] to specify an arbitrary value for this param

type SettingEditParamsBodyValueValueZonesCacheRulesAegisValue 

type SettingEditParamsBodyValueValueZonesCacheRulesAegisValue struct {
	// Whether the feature is enabled or not.
	Enabled param.Field[bool] `json:"enabled"`
	// Egress pool id which refers to a grouping of dedicated egress IPs through which
	// Cloudflare will connect to origin.
	PoolID param.Field[string] `json:"pool_id"`
}

Value of the zone setting.

func (SettingEditParamsBodyValueValueZonesCacheRulesAegisValue) ImplementsSettingEditParamsBodyValueValueUnion 

func (r SettingEditParamsBodyValueValueZonesCacheRulesAegisValue) ImplementsSettingEditParamsBodyValueValueUnion()

func (SettingEditParamsBodyValueValueZonesCacheRulesAegisValue) MarshalJSON 

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

type SettingEditParamsBodyValueValueZonesCiphersValue 

type SettingEditParamsBodyValueValueZonesCiphersValue []string

func (SettingEditParamsBodyValueValueZonesCiphersValue) ImplementsSettingEditParamsBodyValueValueUnion 

func (r SettingEditParamsBodyValueValueZonesCiphersValue) ImplementsSettingEditParamsBodyValueValueUnion()

type SettingEditParamsBodyValueValueZonesNELValue 

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

Value of the zone setting.

func (SettingEditParamsBodyValueValueZonesNELValue) ImplementsSettingEditParamsBodyValueValueUnion 

func (r SettingEditParamsBodyValueValueZonesNELValue) ImplementsSettingEditParamsBodyValueValueUnion()

func (SettingEditParamsBodyValueValueZonesNELValue) MarshalJSON 

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

type SettingEditParamsBodyValueValueZonesSecurityHeaderValue 

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

func (SettingEditParamsBodyValueValueZonesSecurityHeaderValue) ImplementsSettingEditParamsBodyValueValueUnion 

func (r SettingEditParamsBodyValueValueZonesSecurityHeaderValue) ImplementsSettingEditParamsBodyValueValueUnion()

func (SettingEditParamsBodyValueValueZonesSecurityHeaderValue) MarshalJSON 

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

type SettingEditParamsBodyValueValueZonesSecurityHeaderValueStrictTransportSecurity 

type SettingEditParamsBodyValueValueZonesSecurityHeaderValueStrictTransportSecurity 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 (SettingEditParamsBodyValueValueZonesSecurityHeaderValueStrictTransportSecurity) MarshalJSON 

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

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],
	// [SettingEditResponseZonesCacheRulesAegisValue], [AlwaysOnlineValue],
	// [SettingEditResponseZonesSchemasAlwaysUseHTTPSValue],
	// [SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue], [BrotliValue],
	// [int64], [SettingEditResponseZonesSchemasBrowserCheckValue],
	// [SettingEditResponseZonesSchemasCacheLevelValue], [ChallengeTTLValue],
	// [SettingEditResponseZonesChinaNetworkEnabledValue], [[]string],
	// [SettingEditResponseZonesCNAMEFlatteningValue], [DevelopmentModeValue],
	// [EarlyHintsValue], [SettingEditResponseZonesSchemasEdgeCacheTTLValue],
	// [SettingEditResponseZonesSchemasEmailObfuscationValue], [H2PrioritizationValue],
	// [HotlinkProtectionValue], [HTTP2Value], [HTTP3Value], [ImageResizingValue],
	// [SettingEditResponseZonesSchemasIPGeolocationValue], [IPV6Value],
	// [SettingEditResponseZonesMaxUploadValue], [MinTLSVersionValue],
	// [SettingEditResponseZonesSchemasMirageValue], [NELValue],
	// [SettingEditResponseZonesSchemasOpportunisticEncryptionValue],
	// [OpportunisticOnionValue], [OrangeToOrangeValue],
	// [SettingEditResponseZonesSchemasOriginErrorPagePassThruValue],
	// [SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue],
	// [SettingEditResponseZonesSchemasPolishValue], [PrefetchPreloadValue],
	// [SettingEditResponseZonesPrivacyPassValue], [float64], [PseudoIPV4Value],
	// [SettingEditResponseZonesReplaceInsecureJSValue],
	// [SettingEditResponseZonesSchemasResponseBufferingValue],
	// [SettingEditResponseZonesSchemasRocketLoaderValue],
	// [AutomaticPlatformOptimization], [SecurityHeadersValue],
	// [SettingEditResponseZonesSchemasSecurityLevelValue], [ServerSideExcludesValue],
	// [SettingEditResponseZonesSha1SupportValue],
	// [SettingEditResponseZonesSchemasSortQueryStringForCacheValue],
	// [SettingEditResponseZonesSchemasSSLValue],
	// [SettingEditResponseZonesTLS1_2OnlyValue], [TLS1_3Value], [TLSClientAuthValue],
	// [SettingEditResponseZonesTransformationsValue], [string],
	// [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 

func (r SettingEditResponse) AsUnion() SettingEditResponseUnion

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

Possible runtime types of the union are ZeroRTT, AdvancedDDoS, SettingEditResponseZonesCacheRulesAegis, AlwaysOnline, SettingEditResponseZonesSchemasAlwaysUseHTTPS, SettingEditResponseZonesSchemasAutomaticHTTPSRewrites, Brotli, SettingEditResponseZonesSchemasBrowserCacheTTL, SettingEditResponseZonesSchemasBrowserCheck, SettingEditResponseZonesSchemasCacheLevel, ChallengeTTL, SettingEditResponseZonesChinaNetworkEnabled, Ciphers, SettingEditResponseZonesCNAMEFlattening, DevelopmentMode, EarlyHints, SettingEditResponseZonesSchemasEdgeCacheTTL, SettingEditResponseZonesSchemasEmailObfuscation, H2Prioritization, HotlinkProtection, HTTP2, HTTP3, ImageResizing, SettingEditResponseZonesSchemasIPGeolocation, IPV6, SettingEditResponseZonesMaxUpload, MinTLSVersion, SettingEditResponseZonesSchemasMirage, NEL, SettingEditResponseZonesSchemasOpportunisticEncryption, OpportunisticOnion, OrangeToOrange, SettingEditResponseZonesSchemasOriginErrorPagePassThru, SettingEditResponseZonesCacheRulesOriginH2MaxStreams, SettingEditResponseZonesCacheRulesOriginMaxHTTPVersion, SettingEditResponseZonesSchemasPolish, PrefetchPreload, SettingEditResponseZonesPrivacyPass, ProxyReadTimeout, PseudoIPV4, SettingEditResponseZonesReplaceInsecureJS, SettingEditResponseZonesSchemasResponseBuffering, SettingEditResponseZonesSchemasRocketLoader, SettingEditResponseZonesSchemasAutomaticPlatformOptimization, SecurityHeaders, SettingEditResponseZonesSchemasSecurityLevel, ServerSideExcludes, SettingEditResponseZonesSha1Support, SettingEditResponseZonesSchemasSortQueryStringForCache, SettingEditResponseZonesSchemasSSL, SSLRecommender, SettingEditResponseZonesTLS1_2Only, TLS1_3, TLSClientAuth, SettingEditResponseZonesTransformations, SettingEditResponseZonesTransformationsAllowedOrigins, SettingEditResponseZonesSchemasTrueClientIPHeader, SettingEditResponseZonesSchemasWAF, WebP, 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"
	SettingEditResponseIDAegis                         SettingEditResponseID = "aegis"
	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"
	SettingEditResponseIDChinaNetworkEnabled           SettingEditResponseID = "china_network_enabled"
	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"
	SettingEditResponseIDOriginH2MaxStreams            SettingEditResponseID = "origin_h2_max_streams"
	SettingEditResponseIDOriginMaxHTTPVersion          SettingEditResponseID = "origin_max_http_version"
	SettingEditResponseIDPolish                        SettingEditResponseID = "polish"
	SettingEditResponseIDPrefetchPreload               SettingEditResponseID = "prefetch_preload"
	SettingEditResponseIDPrivacyPass                   SettingEditResponseID = "privacy_pass"
	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"
	SettingEditResponseIDTransformations               SettingEditResponseID = "transformations"
	SettingEditResponseIDTransformationsAllowedOrigins SettingEditResponseID = "transformations_allowed_origins"
	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 ZeroRTT, AdvancedDDoS, SettingEditResponseZonesCacheRulesAegis, AlwaysOnline, SettingEditResponseZonesSchemasAlwaysUseHTTPS, SettingEditResponseZonesSchemasAutomaticHTTPSRewrites, Brotli, SettingEditResponseZonesSchemasBrowserCacheTTL, SettingEditResponseZonesSchemasBrowserCheck, SettingEditResponseZonesSchemasCacheLevel, ChallengeTTL, SettingEditResponseZonesChinaNetworkEnabled, Ciphers, SettingEditResponseZonesCNAMEFlattening, DevelopmentMode, EarlyHints, SettingEditResponseZonesSchemasEdgeCacheTTL, SettingEditResponseZonesSchemasEmailObfuscation, H2Prioritization, HotlinkProtection, HTTP2, HTTP3, ImageResizing, SettingEditResponseZonesSchemasIPGeolocation, IPV6, SettingEditResponseZonesMaxUpload, MinTLSVersion, SettingEditResponseZonesSchemasMirage, NEL, SettingEditResponseZonesSchemasOpportunisticEncryption, OpportunisticOnion, OrangeToOrange, SettingEditResponseZonesSchemasOriginErrorPagePassThru, SettingEditResponseZonesCacheRulesOriginH2MaxStreams, SettingEditResponseZonesCacheRulesOriginMaxHTTPVersion, SettingEditResponseZonesSchemasPolish, PrefetchPreload, SettingEditResponseZonesPrivacyPass, ProxyReadTimeout, PseudoIPV4, SettingEditResponseZonesReplaceInsecureJS, SettingEditResponseZonesSchemasResponseBuffering, SettingEditResponseZonesSchemasRocketLoader, SettingEditResponseZonesSchemasAutomaticPlatformOptimization, SecurityHeaders, SettingEditResponseZonesSchemasSecurityLevel, ServerSideExcludes, SettingEditResponseZonesSha1Support, SettingEditResponseZonesSchemasSortQueryStringForCache, SettingEditResponseZonesSchemasSSL, SSLRecommender, SettingEditResponseZonesTLS1_2Only, TLS1_3, TLSClientAuth, SettingEditResponseZonesTransformations, SettingEditResponseZonesTransformationsAllowedOrigins, SettingEditResponseZonesSchemasTrueClientIPHeader, SettingEditResponseZonesSchemasWAF, WebP or Websocket.

type SettingEditResponseZonesCNAMEFlattening deprecated 

type SettingEditResponseZonesCNAMEFlattening struct {
	// How to flatten the cname destination.
	ID SettingEditResponseZonesCNAMEFlatteningID `json:"id,required"`
	// Current value of the zone setting.
	//
	// Deprecated: This zone setting is deprecated; please use the DNS Settings route
	// instead. More information at
	// https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21
	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.

Deprecated: This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21

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 

func (r SettingEditResponseZonesCNAMEFlatteningEditable) IsKnown() bool

type SettingEditResponseZonesCNAMEFlatteningID 

type SettingEditResponseZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingEditResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingEditResponseZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingEditResponseZonesCNAMEFlatteningID) IsKnown 

func (r SettingEditResponseZonesCNAMEFlatteningID) IsKnown() bool

type SettingEditResponseZonesCNAMEFlatteningValue 

type SettingEditResponseZonesCNAMEFlatteningValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesCNAMEFlatteningValue) IsKnown 

func (r SettingEditResponseZonesCNAMEFlatteningValue) IsKnown() bool

type SettingEditResponseZonesCacheRulesAegis 

type SettingEditResponseZonesCacheRulesAegis struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesCacheRulesAegisID `json:"id,required"`
	// Last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the zone setting.
	Value SettingEditResponseZonesCacheRulesAegisValue `json:"value"`
	JSON  settingEditResponseZonesCacheRulesAegisJSON  `json:"-"`
}

Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.

func (*SettingEditResponseZonesCacheRulesAegis) UnmarshalJSON 

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

type SettingEditResponseZonesCacheRulesAegisID 

type SettingEditResponseZonesCacheRulesAegisID string

ID of the zone setting. 

const (
	SettingEditResponseZonesCacheRulesAegisIDAegis SettingEditResponseZonesCacheRulesAegisID = "aegis"
)

func (SettingEditResponseZonesCacheRulesAegisID) IsKnown 

func (r SettingEditResponseZonesCacheRulesAegisID) IsKnown() bool

type SettingEditResponseZonesCacheRulesAegisValue 

type SettingEditResponseZonesCacheRulesAegisValue struct {
	// Whether the feature is enabled or not.
	Enabled bool `json:"enabled"`
	// Egress pool id which refers to a grouping of dedicated egress IPs through which
	// Cloudflare will connect to origin.
	PoolID string                                           `json:"pool_id"`
	JSON   settingEditResponseZonesCacheRulesAegisValueJSON `json:"-"`
}

Value of the zone setting.

func (*SettingEditResponseZonesCacheRulesAegisValue) UnmarshalJSON 

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

type SettingEditResponseZonesCacheRulesOriginH2MaxStreams 

type SettingEditResponseZonesCacheRulesOriginH2MaxStreams struct {
	// Value of the zone setting.
	ID SettingEditResponseZonesCacheRulesOriginH2MaxStreamsID `json:"id,required"`
	// Last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the Origin H2 Max Streams Setting.
	Value int64                                                    `json:"value"`
	JSON  settingEditResponseZonesCacheRulesOriginH2MaxStreamsJSON `json:"-"`
}

Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled.

func (*SettingEditResponseZonesCacheRulesOriginH2MaxStreams) UnmarshalJSON 

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

type SettingEditResponseZonesCacheRulesOriginH2MaxStreamsID 

type SettingEditResponseZonesCacheRulesOriginH2MaxStreamsID string

Value of the zone setting. 

const (
	SettingEditResponseZonesCacheRulesOriginH2MaxStreamsIDOriginH2MaxStreams SettingEditResponseZonesCacheRulesOriginH2MaxStreamsID = "origin_h2_max_streams"
)

func (SettingEditResponseZonesCacheRulesOriginH2MaxStreamsID) IsKnown 

func (r SettingEditResponseZonesCacheRulesOriginH2MaxStreamsID) IsKnown() bool

type SettingEditResponseZonesCacheRulesOriginMaxHTTPVersion 

type SettingEditResponseZonesCacheRulesOriginMaxHTTPVersion struct {
	// Value of the zone setting.
	ID SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionID `json:"id,required"`
	// Last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the Origin Max HTTP Version Setting.
	Value SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue `json:"value"`
	JSON  settingEditResponseZonesCacheRulesOriginMaxHTTPVersionJSON  `json:"-"`
}

Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1"

func (*SettingEditResponseZonesCacheRulesOriginMaxHTTPVersion) UnmarshalJSON 

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

type SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionID 

type SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionID string

Value of the zone setting. 

const (
	SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionIDOriginMaxHTTPVersion SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionID = "origin_max_http_version"
)

func (SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionID) IsKnown 

func (r SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionID) IsKnown() bool

type SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue 

type SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue string

Value of the Origin Max HTTP Version Setting. 

const (
	SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue2 SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue = "2"
	SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue1 SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue = "1"
)

func (SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue) IsKnown 

func (r SettingEditResponseZonesCacheRulesOriginMaxHTTPVersionValue) IsKnown() bool

type SettingEditResponseZonesChinaNetworkEnabled 

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

Determines whether or not the china network is enabled.

func (*SettingEditResponseZonesChinaNetworkEnabled) UnmarshalJSON 

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

type SettingEditResponseZonesChinaNetworkEnabledEditable 

type SettingEditResponseZonesChinaNetworkEnabledEditable bool

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

const (
	SettingEditResponseZonesChinaNetworkEnabledEditableTrue  SettingEditResponseZonesChinaNetworkEnabledEditable = true
	SettingEditResponseZonesChinaNetworkEnabledEditableFalse SettingEditResponseZonesChinaNetworkEnabledEditable = false
)

func (SettingEditResponseZonesChinaNetworkEnabledEditable) IsKnown 

func (r SettingEditResponseZonesChinaNetworkEnabledEditable) IsKnown() bool

type SettingEditResponseZonesChinaNetworkEnabledID 

type SettingEditResponseZonesChinaNetworkEnabledID string

ID of the zone setting. 

const (
	SettingEditResponseZonesChinaNetworkEnabledIDChinaNetworkEnabled SettingEditResponseZonesChinaNetworkEnabledID = "china_network_enabled"
)

func (SettingEditResponseZonesChinaNetworkEnabledID) IsKnown 

func (r SettingEditResponseZonesChinaNetworkEnabledID) IsKnown() bool

type SettingEditResponseZonesChinaNetworkEnabledValue 

type SettingEditResponseZonesChinaNetworkEnabledValue string

Current value of the zone setting. 

const (
	SettingEditResponseZonesChinaNetworkEnabledValueOn  SettingEditResponseZonesChinaNetworkEnabledValue = "on"
	SettingEditResponseZonesChinaNetworkEnabledValueOff SettingEditResponseZonesChinaNetworkEnabledValue = "off"
)

func (SettingEditResponseZonesChinaNetworkEnabledValue) IsKnown 

func (r SettingEditResponseZonesChinaNetworkEnabledValue) IsKnown() bool

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 

func (r SettingEditResponseZonesMaxUploadEditable) IsKnown() bool

type SettingEditResponseZonesMaxUploadID 

type SettingEditResponseZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingEditResponseZonesMaxUploadIDMaxUpload SettingEditResponseZonesMaxUploadID = "max_upload"
)

func (SettingEditResponseZonesMaxUploadID) IsKnown 

func (r SettingEditResponseZonesMaxUploadID) IsKnown() bool

type SettingEditResponseZonesMaxUploadValue 

type SettingEditResponseZonesMaxUploadValue int64

Current value of the zone setting. 

const (
	SettingEditResponseZonesMaxUploadValue100  SettingEditResponseZonesMaxUploadValue = 100
	SettingEditResponseZonesMaxUploadValue125  SettingEditResponseZonesMaxUploadValue = 125
	SettingEditResponseZonesMaxUploadValue150  SettingEditResponseZonesMaxUploadValue = 150
	SettingEditResponseZonesMaxUploadValue175  SettingEditResponseZonesMaxUploadValue = 175
	SettingEditResponseZonesMaxUploadValue200  SettingEditResponseZonesMaxUploadValue = 200
	SettingEditResponseZonesMaxUploadValue225  SettingEditResponseZonesMaxUploadValue = 225
	SettingEditResponseZonesMaxUploadValue250  SettingEditResponseZonesMaxUploadValue = 250
	SettingEditResponseZonesMaxUploadValue275  SettingEditResponseZonesMaxUploadValue = 275
	SettingEditResponseZonesMaxUploadValue300  SettingEditResponseZonesMaxUploadValue = 300
	SettingEditResponseZonesMaxUploadValue325  SettingEditResponseZonesMaxUploadValue = 325
	SettingEditResponseZonesMaxUploadValue350  SettingEditResponseZonesMaxUploadValue = 350
	SettingEditResponseZonesMaxUploadValue375  SettingEditResponseZonesMaxUploadValue = 375
	SettingEditResponseZonesMaxUploadValue400  SettingEditResponseZonesMaxUploadValue = 400
	SettingEditResponseZonesMaxUploadValue425  SettingEditResponseZonesMaxUploadValue = 425
	SettingEditResponseZonesMaxUploadValue450  SettingEditResponseZonesMaxUploadValue = 450
	SettingEditResponseZonesMaxUploadValue475  SettingEditResponseZonesMaxUploadValue = 475
	SettingEditResponseZonesMaxUploadValue500  SettingEditResponseZonesMaxUploadValue = 500
	SettingEditResponseZonesMaxUploadValue1000 SettingEditResponseZonesMaxUploadValue = 1000
)

func (SettingEditResponseZonesMaxUploadValue) IsKnown 

func (r SettingEditResponseZonesMaxUploadValue) IsKnown() bool

type SettingEditResponseZonesPrivacyPass deprecated 

type SettingEditResponseZonesPrivacyPass struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesPrivacyPassID `json:"id,required"`
	// Current value of the zone setting.
	//
	// Deprecated: Privacy Pass v1 was deprecated in 2023. (Announcement -
	// https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation
	// details -
	// https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31)
	Value SettingEditResponseZonesPrivacyPassValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesPrivacyPassEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                               `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesPrivacyPassJSON `json:"-"`
}

Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).

Deprecated: Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31)

func (*SettingEditResponseZonesPrivacyPass) UnmarshalJSON 

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

type SettingEditResponseZonesPrivacyPassEditable 

type SettingEditResponseZonesPrivacyPassEditable bool

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

const (
	SettingEditResponseZonesPrivacyPassEditableTrue  SettingEditResponseZonesPrivacyPassEditable = true
	SettingEditResponseZonesPrivacyPassEditableFalse SettingEditResponseZonesPrivacyPassEditable = false
)

func (SettingEditResponseZonesPrivacyPassEditable) IsKnown 

func (r SettingEditResponseZonesPrivacyPassEditable) IsKnown() bool

type SettingEditResponseZonesPrivacyPassID 

type SettingEditResponseZonesPrivacyPassID string

ID of the zone setting. 

const (
	SettingEditResponseZonesPrivacyPassIDPrivacyPass SettingEditResponseZonesPrivacyPassID = "privacy_pass"
)

func (SettingEditResponseZonesPrivacyPassID) IsKnown 

func (r SettingEditResponseZonesPrivacyPassID) IsKnown() bool

type SettingEditResponseZonesPrivacyPassValue 

type SettingEditResponseZonesPrivacyPassValue string

Current value of the zone setting. 

const (
	SettingEditResponseZonesPrivacyPassValueOn  SettingEditResponseZonesPrivacyPassValue = "on"
	SettingEditResponseZonesPrivacyPassValueOff SettingEditResponseZonesPrivacyPassValue = "off"
)

func (SettingEditResponseZonesPrivacyPassValue) IsKnown 

func (r SettingEditResponseZonesPrivacyPassValue) IsKnown() bool

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 

func (r SettingEditResponseZonesReplaceInsecureJSEditable) IsKnown() bool

type SettingEditResponseZonesReplaceInsecureJSID 

type SettingEditResponseZonesReplaceInsecureJSID string

ID of the zone setting. 

const (
	SettingEditResponseZonesReplaceInsecureJSIDReplaceInsecureJS SettingEditResponseZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingEditResponseZonesReplaceInsecureJSID) IsKnown 

func (r SettingEditResponseZonesReplaceInsecureJSID) IsKnown() bool

type SettingEditResponseZonesReplaceInsecureJSValue 

type SettingEditResponseZonesReplaceInsecureJSValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesReplaceInsecureJSValue) IsKnown 

func (r SettingEditResponseZonesReplaceInsecureJSValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasAlwaysUseHTTPSEditable) IsKnown() bool

type SettingEditResponseZonesSchemasAlwaysUseHTTPSID 

type SettingEditResponseZonesSchemasAlwaysUseHTTPSID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasAlwaysUseHTTPSIDAlwaysUseHTTPS SettingEditResponseZonesSchemasAlwaysUseHTTPSID = "always_use_https"
)

func (SettingEditResponseZonesSchemasAlwaysUseHTTPSID) IsKnown 

func (r SettingEditResponseZonesSchemasAlwaysUseHTTPSID) IsKnown() bool

type SettingEditResponseZonesSchemasAlwaysUseHTTPSValue 

type SettingEditResponseZonesSchemasAlwaysUseHTTPSValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasAlwaysUseHTTPSValue) IsKnown 

func (r SettingEditResponseZonesSchemasAlwaysUseHTTPSValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasAutomaticHTTPSRewritesEditable) IsKnown() bool

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID 

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasAutomaticHTTPSRewritesIDAutomaticHTTPSRewrites SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

func (SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID) IsKnown 

func (r SettingEditResponseZonesSchemasAutomaticHTTPSRewritesID) IsKnown() bool

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue 

type SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue) IsKnown 

func (r SettingEditResponseZonesSchemasAutomaticHTTPSRewritesValue) IsKnown() bool

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 

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

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 

func (r SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown() bool

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID 

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown 

func (r SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown() bool

type SettingEditResponseZonesSchemasBrowserCacheTTL 

type SettingEditResponseZonesSchemasBrowserCacheTTL struct {
	// ID of the zone setting.
	ID SettingEditResponseZonesSchemasBrowserCacheTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value int64 `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 

func (r SettingEditResponseZonesSchemasBrowserCacheTTLEditable) IsKnown() bool

type SettingEditResponseZonesSchemasBrowserCacheTTLID 

type SettingEditResponseZonesSchemasBrowserCacheTTLID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasBrowserCacheTTLIDBrowserCacheTTL SettingEditResponseZonesSchemasBrowserCacheTTLID = "browser_cache_ttl"
)

func (SettingEditResponseZonesSchemasBrowserCacheTTLID) IsKnown 

func (r SettingEditResponseZonesSchemasBrowserCacheTTLID) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasBrowserCheckEditable) IsKnown() bool

type SettingEditResponseZonesSchemasBrowserCheckID 

type SettingEditResponseZonesSchemasBrowserCheckID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasBrowserCheckIDBrowserCheck SettingEditResponseZonesSchemasBrowserCheckID = "browser_check"
)

func (SettingEditResponseZonesSchemasBrowserCheckID) IsKnown 

func (r SettingEditResponseZonesSchemasBrowserCheckID) IsKnown() bool

type SettingEditResponseZonesSchemasBrowserCheckValue 

type SettingEditResponseZonesSchemasBrowserCheckValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasBrowserCheckValue) IsKnown 

func (r SettingEditResponseZonesSchemasBrowserCheckValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasCacheLevelEditable) IsKnown() bool

type SettingEditResponseZonesSchemasCacheLevelID 

type SettingEditResponseZonesSchemasCacheLevelID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasCacheLevelIDCacheLevel SettingEditResponseZonesSchemasCacheLevelID = "cache_level"
)

func (SettingEditResponseZonesSchemasCacheLevelID) IsKnown 

func (r SettingEditResponseZonesSchemasCacheLevelID) IsKnown() bool

type SettingEditResponseZonesSchemasCacheLevelValue 

type SettingEditResponseZonesSchemasCacheLevelValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasCacheLevelValue) IsKnown 

func (r SettingEditResponseZonesSchemasCacheLevelValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasEdgeCacheTTLEditable) IsKnown() bool

type SettingEditResponseZonesSchemasEdgeCacheTTLID 

type SettingEditResponseZonesSchemasEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasEdgeCacheTTLIDEdgeCacheTTL SettingEditResponseZonesSchemasEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingEditResponseZonesSchemasEdgeCacheTTLID) IsKnown 

func (r SettingEditResponseZonesSchemasEdgeCacheTTLID) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasEdgeCacheTTLValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasEmailObfuscationEditable) IsKnown() bool

type SettingEditResponseZonesSchemasEmailObfuscationID 

type SettingEditResponseZonesSchemasEmailObfuscationID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasEmailObfuscationIDEmailObfuscation SettingEditResponseZonesSchemasEmailObfuscationID = "email_obfuscation"
)

func (SettingEditResponseZonesSchemasEmailObfuscationID) IsKnown 

func (r SettingEditResponseZonesSchemasEmailObfuscationID) IsKnown() bool

type SettingEditResponseZonesSchemasEmailObfuscationValue 

type SettingEditResponseZonesSchemasEmailObfuscationValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasEmailObfuscationValue) IsKnown 

func (r SettingEditResponseZonesSchemasEmailObfuscationValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasIPGeolocationEditable) IsKnown() bool

type SettingEditResponseZonesSchemasIPGeolocationID 

type SettingEditResponseZonesSchemasIPGeolocationID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasIPGeolocationIDIPGeolocation SettingEditResponseZonesSchemasIPGeolocationID = "ip_geolocation"
)

func (SettingEditResponseZonesSchemasIPGeolocationID) IsKnown 

func (r SettingEditResponseZonesSchemasIPGeolocationID) IsKnown() bool

type SettingEditResponseZonesSchemasIPGeolocationValue 

type SettingEditResponseZonesSchemasIPGeolocationValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasIPGeolocationValue) IsKnown 

func (r SettingEditResponseZonesSchemasIPGeolocationValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasMirageEditable) IsKnown() bool

type SettingEditResponseZonesSchemasMirageID 

type SettingEditResponseZonesSchemasMirageID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasMirageIDMirage SettingEditResponseZonesSchemasMirageID = "mirage"
)

func (SettingEditResponseZonesSchemasMirageID) IsKnown 

func (r SettingEditResponseZonesSchemasMirageID) IsKnown() bool

type SettingEditResponseZonesSchemasMirageValue 

type SettingEditResponseZonesSchemasMirageValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasMirageValue) IsKnown 

func (r SettingEditResponseZonesSchemasMirageValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasOpportunisticEncryptionEditable) IsKnown() bool

type SettingEditResponseZonesSchemasOpportunisticEncryptionID 

type SettingEditResponseZonesSchemasOpportunisticEncryptionID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasOpportunisticEncryptionIDOpportunisticEncryption SettingEditResponseZonesSchemasOpportunisticEncryptionID = "opportunistic_encryption"
)

func (SettingEditResponseZonesSchemasOpportunisticEncryptionID) IsKnown 

func (r SettingEditResponseZonesSchemasOpportunisticEncryptionID) IsKnown() bool

type SettingEditResponseZonesSchemasOpportunisticEncryptionValue 

type SettingEditResponseZonesSchemasOpportunisticEncryptionValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasOpportunisticEncryptionValue) IsKnown 

func (r SettingEditResponseZonesSchemasOpportunisticEncryptionValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasOriginErrorPagePassThruEditable) IsKnown() bool

type SettingEditResponseZonesSchemasOriginErrorPagePassThruID 

type SettingEditResponseZonesSchemasOriginErrorPagePassThruID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasOriginErrorPagePassThruIDOriginErrorPagePassThru SettingEditResponseZonesSchemasOriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

func (SettingEditResponseZonesSchemasOriginErrorPagePassThruID) IsKnown 

func (r SettingEditResponseZonesSchemasOriginErrorPagePassThruID) IsKnown() bool

type SettingEditResponseZonesSchemasOriginErrorPagePassThruValue 

type SettingEditResponseZonesSchemasOriginErrorPagePassThruValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasOriginErrorPagePassThruValue) IsKnown 

func (r SettingEditResponseZonesSchemasOriginErrorPagePassThruValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasPolishEditable) IsKnown() bool

type SettingEditResponseZonesSchemasPolishID 

type SettingEditResponseZonesSchemasPolishID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasPolishIDPolish SettingEditResponseZonesSchemasPolishID = "polish"
)

func (SettingEditResponseZonesSchemasPolishID) IsKnown 

func (r SettingEditResponseZonesSchemasPolishID) IsKnown() bool

type SettingEditResponseZonesSchemasPolishValue 

type SettingEditResponseZonesSchemasPolishValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasPolishValue) IsKnown 

func (r SettingEditResponseZonesSchemasPolishValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasResponseBufferingEditable) IsKnown() bool

type SettingEditResponseZonesSchemasResponseBufferingID 

type SettingEditResponseZonesSchemasResponseBufferingID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasResponseBufferingIDResponseBuffering SettingEditResponseZonesSchemasResponseBufferingID = "response_buffering"
)

func (SettingEditResponseZonesSchemasResponseBufferingID) IsKnown 

func (r SettingEditResponseZonesSchemasResponseBufferingID) IsKnown() bool

type SettingEditResponseZonesSchemasResponseBufferingValue 

type SettingEditResponseZonesSchemasResponseBufferingValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasResponseBufferingValue) IsKnown 

func (r SettingEditResponseZonesSchemasResponseBufferingValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasRocketLoaderEditable) IsKnown() bool

type SettingEditResponseZonesSchemasRocketLoaderID 

type SettingEditResponseZonesSchemasRocketLoaderID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasRocketLoaderIDRocketLoader SettingEditResponseZonesSchemasRocketLoaderID = "rocket_loader"
)

func (SettingEditResponseZonesSchemasRocketLoaderID) IsKnown 

func (r SettingEditResponseZonesSchemasRocketLoaderID) IsKnown() bool

type SettingEditResponseZonesSchemasRocketLoaderValue 

type SettingEditResponseZonesSchemasRocketLoaderValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasRocketLoaderValue) IsKnown 

func (r SettingEditResponseZonesSchemasRocketLoaderValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasSSLEditable) IsKnown() bool

type SettingEditResponseZonesSchemasSSLID 

type SettingEditResponseZonesSchemasSSLID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasSSLIDSSL SettingEditResponseZonesSchemasSSLID = "ssl"
)

func (SettingEditResponseZonesSchemasSSLID) IsKnown 

func (r SettingEditResponseZonesSchemasSSLID) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasSSLValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasSecurityLevelEditable) IsKnown() bool

type SettingEditResponseZonesSchemasSecurityLevelID 

type SettingEditResponseZonesSchemasSecurityLevelID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasSecurityLevelIDSecurityLevel SettingEditResponseZonesSchemasSecurityLevelID = "security_level"
)

func (SettingEditResponseZonesSchemasSecurityLevelID) IsKnown 

func (r SettingEditResponseZonesSchemasSecurityLevelID) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasSecurityLevelValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasSortQueryStringForCacheEditable) IsKnown() bool

type SettingEditResponseZonesSchemasSortQueryStringForCacheID 

type SettingEditResponseZonesSchemasSortQueryStringForCacheID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasSortQueryStringForCacheIDSortQueryStringForCache SettingEditResponseZonesSchemasSortQueryStringForCacheID = "sort_query_string_for_cache"
)

func (SettingEditResponseZonesSchemasSortQueryStringForCacheID) IsKnown 

func (r SettingEditResponseZonesSchemasSortQueryStringForCacheID) IsKnown() bool

type SettingEditResponseZonesSchemasSortQueryStringForCacheValue 

type SettingEditResponseZonesSchemasSortQueryStringForCacheValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasSortQueryStringForCacheValue) IsKnown 

func (r SettingEditResponseZonesSchemasSortQueryStringForCacheValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasTrueClientIPHeaderEditable) IsKnown() bool

type SettingEditResponseZonesSchemasTrueClientIPHeaderID 

type SettingEditResponseZonesSchemasTrueClientIPHeaderID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasTrueClientIPHeaderIDTrueClientIPHeader SettingEditResponseZonesSchemasTrueClientIPHeaderID = "true_client_ip_header"
)

func (SettingEditResponseZonesSchemasTrueClientIPHeaderID) IsKnown 

func (r SettingEditResponseZonesSchemasTrueClientIPHeaderID) IsKnown() bool

type SettingEditResponseZonesSchemasTrueClientIPHeaderValue 

type SettingEditResponseZonesSchemasTrueClientIPHeaderValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasTrueClientIPHeaderValue) IsKnown 

func (r SettingEditResponseZonesSchemasTrueClientIPHeaderValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSchemasWAFEditable) IsKnown() bool

type SettingEditResponseZonesSchemasWAFID 

type SettingEditResponseZonesSchemasWAFID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasWAFIDWAF SettingEditResponseZonesSchemasWAFID = "waf"
)

func (SettingEditResponseZonesSchemasWAFID) IsKnown 

func (r SettingEditResponseZonesSchemasWAFID) IsKnown() bool

type SettingEditResponseZonesSchemasWAFValue 

type SettingEditResponseZonesSchemasWAFValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSchemasWAFValue) IsKnown 

func (r SettingEditResponseZonesSchemasWAFValue) IsKnown() bool

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 

func (r SettingEditResponseZonesSha1SupportEditable) IsKnown() bool

type SettingEditResponseZonesSha1SupportID 

type SettingEditResponseZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingEditResponseZonesSha1SupportIDSha1Support SettingEditResponseZonesSha1SupportID = "sha1_support"
)

func (SettingEditResponseZonesSha1SupportID) IsKnown 

func (r SettingEditResponseZonesSha1SupportID) IsKnown() bool

type SettingEditResponseZonesSha1SupportValue 

type SettingEditResponseZonesSha1SupportValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSha1SupportValue) IsKnown 

func (r SettingEditResponseZonesSha1SupportValue) IsKnown() bool

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 

func (r SettingEditResponseZonesTLS1_2OnlyEditable) IsKnown() bool

type SettingEditResponseZonesTLS1_2OnlyID 

type SettingEditResponseZonesTLS1_2OnlyID string

Zone setting identifier. 

const (
	SettingEditResponseZonesTLS1_2OnlyIDTLS1_2Only SettingEditResponseZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingEditResponseZonesTLS1_2OnlyID) IsKnown 

func (r SettingEditResponseZonesTLS1_2OnlyID) IsKnown() bool

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 

func (r SettingEditResponseZonesTLS1_2OnlyValue) IsKnown() bool

type SettingEditResponseZonesTransformations 

type SettingEditResponseZonesTransformations struct {
	// ID of the zone setting. Shared between Image Transformations and Video
	// Transformations.
	ID SettingEditResponseZonesTransformationsID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingEditResponseZonesTransformationsValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseZonesTransformationsEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                   `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesTransformationsJSON `json:"-"`
}

Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.

func (*SettingEditResponseZonesTransformations) UnmarshalJSON 

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

type SettingEditResponseZonesTransformationsAllowedOrigins 

type SettingEditResponseZonesTransformationsAllowedOrigins struct {
	// ID of the zone setting. Shared between Image Transformations and Video
	// Transformations.
	ID SettingEditResponseZonesTransformationsAllowedOriginsID `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 SettingEditResponseZonesTransformationsAllowedOriginsEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                 `json:"modified_on,nullable" format:"date-time"`
	JSON       settingEditResponseZonesTransformationsAllowedOriginsJSON `json:"-"`
}

Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.

func (*SettingEditResponseZonesTransformationsAllowedOrigins) UnmarshalJSON 

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

type SettingEditResponseZonesTransformationsAllowedOriginsEditable 

type SettingEditResponseZonesTransformationsAllowedOriginsEditable bool

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

const (
	SettingEditResponseZonesTransformationsAllowedOriginsEditableTrue  SettingEditResponseZonesTransformationsAllowedOriginsEditable = true
	SettingEditResponseZonesTransformationsAllowedOriginsEditableFalse SettingEditResponseZonesTransformationsAllowedOriginsEditable = false
)

func (SettingEditResponseZonesTransformationsAllowedOriginsEditable) IsKnown 

func (r SettingEditResponseZonesTransformationsAllowedOriginsEditable) IsKnown() bool

type SettingEditResponseZonesTransformationsAllowedOriginsID 

type SettingEditResponseZonesTransformationsAllowedOriginsID string

ID of the zone setting. Shared between Image Transformations and Video Transformations. 

const (
	SettingEditResponseZonesTransformationsAllowedOriginsIDTransformationsAllowedOrigins SettingEditResponseZonesTransformationsAllowedOriginsID = "transformations_allowed_origins"
)

func (SettingEditResponseZonesTransformationsAllowedOriginsID) IsKnown 

func (r SettingEditResponseZonesTransformationsAllowedOriginsID) IsKnown() bool

type SettingEditResponseZonesTransformationsEditable 

type SettingEditResponseZonesTransformationsEditable bool

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

const (
	SettingEditResponseZonesTransformationsEditableTrue  SettingEditResponseZonesTransformationsEditable = true
	SettingEditResponseZonesTransformationsEditableFalse SettingEditResponseZonesTransformationsEditable = false
)

func (SettingEditResponseZonesTransformationsEditable) IsKnown 

func (r SettingEditResponseZonesTransformationsEditable) IsKnown() bool

type SettingEditResponseZonesTransformationsID 

type SettingEditResponseZonesTransformationsID string

ID of the zone setting. Shared between Image Transformations and Video Transformations. 

const (
	SettingEditResponseZonesTransformationsIDTransformations SettingEditResponseZonesTransformationsID = "transformations"
)

func (SettingEditResponseZonesTransformationsID) IsKnown 

func (r SettingEditResponseZonesTransformationsID) IsKnown() bool

type SettingEditResponseZonesTransformationsValue 

type SettingEditResponseZonesTransformationsValue string

Current value of the zone setting. 

const (
	SettingEditResponseZonesTransformationsValueOn   SettingEditResponseZonesTransformationsValue = "on"
	SettingEditResponseZonesTransformationsValueOff  SettingEditResponseZonesTransformationsValue = "off"
	SettingEditResponseZonesTransformationsValueOpen SettingEditResponseZonesTransformationsValue = "open"
)

func (SettingEditResponseZonesTransformationsValue) IsKnown 

func (r SettingEditResponseZonesTransformationsValue) IsKnown() bool

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],
	// [SettingGetResponseZonesCacheRulesAegisValue], [AlwaysOnlineValue],
	// [SettingGetResponseZonesSchemasAlwaysUseHTTPSValue],
	// [SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue], [BrotliValue],
	// [int64], [SettingGetResponseZonesSchemasBrowserCheckValue],
	// [SettingGetResponseZonesSchemasCacheLevelValue], [ChallengeTTLValue],
	// [SettingGetResponseZonesChinaNetworkEnabledValue], [[]string],
	// [SettingGetResponseZonesCNAMEFlatteningValue], [DevelopmentModeValue],
	// [EarlyHintsValue], [SettingGetResponseZonesSchemasEdgeCacheTTLValue],
	// [SettingGetResponseZonesSchemasEmailObfuscationValue], [H2PrioritizationValue],
	// [HotlinkProtectionValue], [HTTP2Value], [HTTP3Value], [ImageResizingValue],
	// [SettingGetResponseZonesSchemasIPGeolocationValue], [IPV6Value],
	// [SettingGetResponseZonesMaxUploadValue], [MinTLSVersionValue],
	// [SettingGetResponseZonesSchemasMirageValue], [NELValue],
	// [SettingGetResponseZonesSchemasOpportunisticEncryptionValue],
	// [OpportunisticOnionValue], [OrangeToOrangeValue],
	// [SettingGetResponseZonesSchemasOriginErrorPagePassThruValue],
	// [SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue],
	// [SettingGetResponseZonesSchemasPolishValue], [PrefetchPreloadValue],
	// [SettingGetResponseZonesPrivacyPassValue], [float64], [PseudoIPV4Value],
	// [SettingGetResponseZonesReplaceInsecureJSValue],
	// [SettingGetResponseZonesSchemasResponseBufferingValue],
	// [SettingGetResponseZonesSchemasRocketLoaderValue],
	// [AutomaticPlatformOptimization], [SecurityHeadersValue],
	// [SettingGetResponseZonesSchemasSecurityLevelValue], [ServerSideExcludesValue],
	// [SettingGetResponseZonesSha1SupportValue],
	// [SettingGetResponseZonesSchemasSortQueryStringForCacheValue],
	// [SettingGetResponseZonesSchemasSSLValue],
	// [SettingGetResponseZonesTLS1_2OnlyValue], [TLS1_3Value], [TLSClientAuthValue],
	// [SettingGetResponseZonesTransformationsValue], [string],
	// [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 

func (r SettingGetResponse) AsUnion() SettingGetResponseUnion

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

Possible runtime types of the union are ZeroRTT, AdvancedDDoS, SettingGetResponseZonesCacheRulesAegis, AlwaysOnline, SettingGetResponseZonesSchemasAlwaysUseHTTPS, SettingGetResponseZonesSchemasAutomaticHTTPSRewrites, Brotli, SettingGetResponseZonesSchemasBrowserCacheTTL, SettingGetResponseZonesSchemasBrowserCheck, SettingGetResponseZonesSchemasCacheLevel, ChallengeTTL, SettingGetResponseZonesChinaNetworkEnabled, Ciphers, SettingGetResponseZonesCNAMEFlattening, DevelopmentMode, EarlyHints, SettingGetResponseZonesSchemasEdgeCacheTTL, SettingGetResponseZonesSchemasEmailObfuscation, H2Prioritization, HotlinkProtection, HTTP2, HTTP3, ImageResizing, SettingGetResponseZonesSchemasIPGeolocation, IPV6, SettingGetResponseZonesMaxUpload, MinTLSVersion, SettingGetResponseZonesSchemasMirage, NEL, SettingGetResponseZonesSchemasOpportunisticEncryption, OpportunisticOnion, OrangeToOrange, SettingGetResponseZonesSchemasOriginErrorPagePassThru, SettingGetResponseZonesCacheRulesOriginH2MaxStreams, SettingGetResponseZonesCacheRulesOriginMaxHTTPVersion, SettingGetResponseZonesSchemasPolish, PrefetchPreload, SettingGetResponseZonesPrivacyPass, ProxyReadTimeout, PseudoIPV4, SettingGetResponseZonesReplaceInsecureJS, SettingGetResponseZonesSchemasResponseBuffering, SettingGetResponseZonesSchemasRocketLoader, SettingGetResponseZonesSchemasAutomaticPlatformOptimization, SecurityHeaders, SettingGetResponseZonesSchemasSecurityLevel, ServerSideExcludes, SettingGetResponseZonesSha1Support, SettingGetResponseZonesSchemasSortQueryStringForCache, SettingGetResponseZonesSchemasSSL, SSLRecommender, SettingGetResponseZonesTLS1_2Only, TLS1_3, TLSClientAuth, SettingGetResponseZonesTransformations, SettingGetResponseZonesTransformationsAllowedOrigins, SettingGetResponseZonesSchemasTrueClientIPHeader, SettingGetResponseZonesSchemasWAF, WebP, 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"
	SettingGetResponseIDAegis                         SettingGetResponseID = "aegis"
	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"
	SettingGetResponseIDChinaNetworkEnabled           SettingGetResponseID = "china_network_enabled"
	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"
	SettingGetResponseIDOriginH2MaxStreams            SettingGetResponseID = "origin_h2_max_streams"
	SettingGetResponseIDOriginMaxHTTPVersion          SettingGetResponseID = "origin_max_http_version"
	SettingGetResponseIDPolish                        SettingGetResponseID = "polish"
	SettingGetResponseIDPrefetchPreload               SettingGetResponseID = "prefetch_preload"
	SettingGetResponseIDPrivacyPass                   SettingGetResponseID = "privacy_pass"
	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"
	SettingGetResponseIDTransformations               SettingGetResponseID = "transformations"
	SettingGetResponseIDTransformationsAllowedOrigins SettingGetResponseID = "transformations_allowed_origins"
	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 ZeroRTT, AdvancedDDoS, SettingGetResponseZonesCacheRulesAegis, AlwaysOnline, SettingGetResponseZonesSchemasAlwaysUseHTTPS, SettingGetResponseZonesSchemasAutomaticHTTPSRewrites, Brotli, SettingGetResponseZonesSchemasBrowserCacheTTL, SettingGetResponseZonesSchemasBrowserCheck, SettingGetResponseZonesSchemasCacheLevel, ChallengeTTL, SettingGetResponseZonesChinaNetworkEnabled, Ciphers, SettingGetResponseZonesCNAMEFlattening, DevelopmentMode, EarlyHints, SettingGetResponseZonesSchemasEdgeCacheTTL, SettingGetResponseZonesSchemasEmailObfuscation, H2Prioritization, HotlinkProtection, HTTP2, HTTP3, ImageResizing, SettingGetResponseZonesSchemasIPGeolocation, IPV6, SettingGetResponseZonesMaxUpload, MinTLSVersion, SettingGetResponseZonesSchemasMirage, NEL, SettingGetResponseZonesSchemasOpportunisticEncryption, OpportunisticOnion, OrangeToOrange, SettingGetResponseZonesSchemasOriginErrorPagePassThru, SettingGetResponseZonesCacheRulesOriginH2MaxStreams, SettingGetResponseZonesCacheRulesOriginMaxHTTPVersion, SettingGetResponseZonesSchemasPolish, PrefetchPreload, SettingGetResponseZonesPrivacyPass, ProxyReadTimeout, PseudoIPV4, SettingGetResponseZonesReplaceInsecureJS, SettingGetResponseZonesSchemasResponseBuffering, SettingGetResponseZonesSchemasRocketLoader, SettingGetResponseZonesSchemasAutomaticPlatformOptimization, SecurityHeaders, SettingGetResponseZonesSchemasSecurityLevel, ServerSideExcludes, SettingGetResponseZonesSha1Support, SettingGetResponseZonesSchemasSortQueryStringForCache, SettingGetResponseZonesSchemasSSL, SSLRecommender, SettingGetResponseZonesTLS1_2Only, TLS1_3, TLSClientAuth, SettingGetResponseZonesTransformations, SettingGetResponseZonesTransformationsAllowedOrigins, SettingGetResponseZonesSchemasTrueClientIPHeader, SettingGetResponseZonesSchemasWAF, WebP or Websocket.

type SettingGetResponseZonesCNAMEFlattening deprecated 

type SettingGetResponseZonesCNAMEFlattening struct {
	// How to flatten the cname destination.
	ID SettingGetResponseZonesCNAMEFlatteningID `json:"id,required"`
	// Current value of the zone setting.
	//
	// Deprecated: This zone setting is deprecated; please use the DNS Settings route
	// instead. More information at
	// https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21
	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.

Deprecated: This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21

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 

func (r SettingGetResponseZonesCNAMEFlatteningEditable) IsKnown() bool

type SettingGetResponseZonesCNAMEFlatteningID 

type SettingGetResponseZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingGetResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingGetResponseZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingGetResponseZonesCNAMEFlatteningID) IsKnown 

func (r SettingGetResponseZonesCNAMEFlatteningID) IsKnown() bool

type SettingGetResponseZonesCNAMEFlatteningValue 

type SettingGetResponseZonesCNAMEFlatteningValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesCNAMEFlatteningValue) IsKnown 

func (r SettingGetResponseZonesCNAMEFlatteningValue) IsKnown() bool

type SettingGetResponseZonesCacheRulesAegis 

type SettingGetResponseZonesCacheRulesAegis struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesCacheRulesAegisID `json:"id,required"`
	// Last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the zone setting.
	Value SettingGetResponseZonesCacheRulesAegisValue `json:"value"`
	JSON  settingGetResponseZonesCacheRulesAegisJSON  `json:"-"`
}

Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.

func (*SettingGetResponseZonesCacheRulesAegis) UnmarshalJSON 

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

type SettingGetResponseZonesCacheRulesAegisID 

type SettingGetResponseZonesCacheRulesAegisID string

ID of the zone setting. 

const (
	SettingGetResponseZonesCacheRulesAegisIDAegis SettingGetResponseZonesCacheRulesAegisID = "aegis"
)

func (SettingGetResponseZonesCacheRulesAegisID) IsKnown 

func (r SettingGetResponseZonesCacheRulesAegisID) IsKnown() bool

type SettingGetResponseZonesCacheRulesAegisValue 

type SettingGetResponseZonesCacheRulesAegisValue struct {
	// Whether the feature is enabled or not.
	Enabled bool `json:"enabled"`
	// Egress pool id which refers to a grouping of dedicated egress IPs through which
	// Cloudflare will connect to origin.
	PoolID string                                          `json:"pool_id"`
	JSON   settingGetResponseZonesCacheRulesAegisValueJSON `json:"-"`
}

Value of the zone setting.

func (*SettingGetResponseZonesCacheRulesAegisValue) UnmarshalJSON 

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

type SettingGetResponseZonesCacheRulesOriginH2MaxStreams 

type SettingGetResponseZonesCacheRulesOriginH2MaxStreams struct {
	// Value of the zone setting.
	ID SettingGetResponseZonesCacheRulesOriginH2MaxStreamsID `json:"id,required"`
	// Last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the Origin H2 Max Streams Setting.
	Value int64                                                   `json:"value"`
	JSON  settingGetResponseZonesCacheRulesOriginH2MaxStreamsJSON `json:"-"`
}

Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled.

func (*SettingGetResponseZonesCacheRulesOriginH2MaxStreams) UnmarshalJSON 

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

type SettingGetResponseZonesCacheRulesOriginH2MaxStreamsID 

type SettingGetResponseZonesCacheRulesOriginH2MaxStreamsID string

Value of the zone setting. 

const (
	SettingGetResponseZonesCacheRulesOriginH2MaxStreamsIDOriginH2MaxStreams SettingGetResponseZonesCacheRulesOriginH2MaxStreamsID = "origin_h2_max_streams"
)

func (SettingGetResponseZonesCacheRulesOriginH2MaxStreamsID) IsKnown 

func (r SettingGetResponseZonesCacheRulesOriginH2MaxStreamsID) IsKnown() bool

type SettingGetResponseZonesCacheRulesOriginMaxHTTPVersion 

type SettingGetResponseZonesCacheRulesOriginMaxHTTPVersion struct {
	// Value of the zone setting.
	ID SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionID `json:"id,required"`
	// Last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// Value of the Origin Max HTTP Version Setting.
	Value SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue `json:"value"`
	JSON  settingGetResponseZonesCacheRulesOriginMaxHTTPVersionJSON  `json:"-"`
}

Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1"

func (*SettingGetResponseZonesCacheRulesOriginMaxHTTPVersion) UnmarshalJSON 

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

type SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionID 

type SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionID string

Value of the zone setting. 

const (
	SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionIDOriginMaxHTTPVersion SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionID = "origin_max_http_version"
)

func (SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionID) IsKnown 

func (r SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionID) IsKnown() bool

type SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue 

type SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue string

Value of the Origin Max HTTP Version Setting. 

const (
	SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue2 SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue = "2"
	SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue1 SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue = "1"
)

func (SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue) IsKnown 

func (r SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue) IsKnown() bool

type SettingGetResponseZonesChinaNetworkEnabled 

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

Determines whether or not the china network is enabled.

func (*SettingGetResponseZonesChinaNetworkEnabled) UnmarshalJSON 

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

type SettingGetResponseZonesChinaNetworkEnabledEditable 

type SettingGetResponseZonesChinaNetworkEnabledEditable bool

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

const (
	SettingGetResponseZonesChinaNetworkEnabledEditableTrue  SettingGetResponseZonesChinaNetworkEnabledEditable = true
	SettingGetResponseZonesChinaNetworkEnabledEditableFalse SettingGetResponseZonesChinaNetworkEnabledEditable = false
)

func (SettingGetResponseZonesChinaNetworkEnabledEditable) IsKnown 

func (r SettingGetResponseZonesChinaNetworkEnabledEditable) IsKnown() bool

type SettingGetResponseZonesChinaNetworkEnabledID 

type SettingGetResponseZonesChinaNetworkEnabledID string

ID of the zone setting. 

const (
	SettingGetResponseZonesChinaNetworkEnabledIDChinaNetworkEnabled SettingGetResponseZonesChinaNetworkEnabledID = "china_network_enabled"
)

func (SettingGetResponseZonesChinaNetworkEnabledID) IsKnown 

func (r SettingGetResponseZonesChinaNetworkEnabledID) IsKnown() bool

type SettingGetResponseZonesChinaNetworkEnabledValue 

type SettingGetResponseZonesChinaNetworkEnabledValue string

Current value of the zone setting. 

const (
	SettingGetResponseZonesChinaNetworkEnabledValueOn  SettingGetResponseZonesChinaNetworkEnabledValue = "on"
	SettingGetResponseZonesChinaNetworkEnabledValueOff SettingGetResponseZonesChinaNetworkEnabledValue = "off"
)

func (SettingGetResponseZonesChinaNetworkEnabledValue) IsKnown 

func (r SettingGetResponseZonesChinaNetworkEnabledValue) IsKnown() bool

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 

func (r SettingGetResponseZonesMaxUploadEditable) IsKnown() bool

type SettingGetResponseZonesMaxUploadID 

type SettingGetResponseZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingGetResponseZonesMaxUploadIDMaxUpload SettingGetResponseZonesMaxUploadID = "max_upload"
)

func (SettingGetResponseZonesMaxUploadID) IsKnown 

func (r SettingGetResponseZonesMaxUploadID) IsKnown() bool

type SettingGetResponseZonesMaxUploadValue 

type SettingGetResponseZonesMaxUploadValue int64

Current value of the zone setting. 

const (
	SettingGetResponseZonesMaxUploadValue100  SettingGetResponseZonesMaxUploadValue = 100
	SettingGetResponseZonesMaxUploadValue125  SettingGetResponseZonesMaxUploadValue = 125
	SettingGetResponseZonesMaxUploadValue150  SettingGetResponseZonesMaxUploadValue = 150
	SettingGetResponseZonesMaxUploadValue175  SettingGetResponseZonesMaxUploadValue = 175
	SettingGetResponseZonesMaxUploadValue200  SettingGetResponseZonesMaxUploadValue = 200
	SettingGetResponseZonesMaxUploadValue225  SettingGetResponseZonesMaxUploadValue = 225
	SettingGetResponseZonesMaxUploadValue250  SettingGetResponseZonesMaxUploadValue = 250
	SettingGetResponseZonesMaxUploadValue275  SettingGetResponseZonesMaxUploadValue = 275
	SettingGetResponseZonesMaxUploadValue300  SettingGetResponseZonesMaxUploadValue = 300
	SettingGetResponseZonesMaxUploadValue325  SettingGetResponseZonesMaxUploadValue = 325
	SettingGetResponseZonesMaxUploadValue350  SettingGetResponseZonesMaxUploadValue = 350
	SettingGetResponseZonesMaxUploadValue375  SettingGetResponseZonesMaxUploadValue = 375
	SettingGetResponseZonesMaxUploadValue400  SettingGetResponseZonesMaxUploadValue = 400
	SettingGetResponseZonesMaxUploadValue425  SettingGetResponseZonesMaxUploadValue = 425
	SettingGetResponseZonesMaxUploadValue450  SettingGetResponseZonesMaxUploadValue = 450
	SettingGetResponseZonesMaxUploadValue475  SettingGetResponseZonesMaxUploadValue = 475
	SettingGetResponseZonesMaxUploadValue500  SettingGetResponseZonesMaxUploadValue = 500
	SettingGetResponseZonesMaxUploadValue1000 SettingGetResponseZonesMaxUploadValue = 1000
)

func (SettingGetResponseZonesMaxUploadValue) IsKnown 

func (r SettingGetResponseZonesMaxUploadValue) IsKnown() bool

type SettingGetResponseZonesPrivacyPass deprecated 

type SettingGetResponseZonesPrivacyPass struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesPrivacyPassID `json:"id,required"`
	// Current value of the zone setting.
	//
	// Deprecated: Privacy Pass v1 was deprecated in 2023. (Announcement -
	// https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation
	// details -
	// https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31)
	Value SettingGetResponseZonesPrivacyPassValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesPrivacyPassEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                              `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesPrivacyPassJSON `json:"-"`
}

Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).

Deprecated: Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31)

func (*SettingGetResponseZonesPrivacyPass) UnmarshalJSON 

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

type SettingGetResponseZonesPrivacyPassEditable 

type SettingGetResponseZonesPrivacyPassEditable bool

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

const (
	SettingGetResponseZonesPrivacyPassEditableTrue  SettingGetResponseZonesPrivacyPassEditable = true
	SettingGetResponseZonesPrivacyPassEditableFalse SettingGetResponseZonesPrivacyPassEditable = false
)

func (SettingGetResponseZonesPrivacyPassEditable) IsKnown 

func (r SettingGetResponseZonesPrivacyPassEditable) IsKnown() bool

type SettingGetResponseZonesPrivacyPassID 

type SettingGetResponseZonesPrivacyPassID string

ID of the zone setting. 

const (
	SettingGetResponseZonesPrivacyPassIDPrivacyPass SettingGetResponseZonesPrivacyPassID = "privacy_pass"
)

func (SettingGetResponseZonesPrivacyPassID) IsKnown 

func (r SettingGetResponseZonesPrivacyPassID) IsKnown() bool

type SettingGetResponseZonesPrivacyPassValue 

type SettingGetResponseZonesPrivacyPassValue string

Current value of the zone setting. 

const (
	SettingGetResponseZonesPrivacyPassValueOn  SettingGetResponseZonesPrivacyPassValue = "on"
	SettingGetResponseZonesPrivacyPassValueOff SettingGetResponseZonesPrivacyPassValue = "off"
)

func (SettingGetResponseZonesPrivacyPassValue) IsKnown 

func (r SettingGetResponseZonesPrivacyPassValue) IsKnown() bool

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 

func (r SettingGetResponseZonesReplaceInsecureJSEditable) IsKnown() bool

type SettingGetResponseZonesReplaceInsecureJSID 

type SettingGetResponseZonesReplaceInsecureJSID string

ID of the zone setting. 

const (
	SettingGetResponseZonesReplaceInsecureJSIDReplaceInsecureJS SettingGetResponseZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingGetResponseZonesReplaceInsecureJSID) IsKnown 

func (r SettingGetResponseZonesReplaceInsecureJSID) IsKnown() bool

type SettingGetResponseZonesReplaceInsecureJSValue 

type SettingGetResponseZonesReplaceInsecureJSValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesReplaceInsecureJSValue) IsKnown 

func (r SettingGetResponseZonesReplaceInsecureJSValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasAlwaysUseHTTPSEditable) IsKnown() bool

type SettingGetResponseZonesSchemasAlwaysUseHTTPSID 

type SettingGetResponseZonesSchemasAlwaysUseHTTPSID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasAlwaysUseHTTPSIDAlwaysUseHTTPS SettingGetResponseZonesSchemasAlwaysUseHTTPSID = "always_use_https"
)

func (SettingGetResponseZonesSchemasAlwaysUseHTTPSID) IsKnown 

func (r SettingGetResponseZonesSchemasAlwaysUseHTTPSID) IsKnown() bool

type SettingGetResponseZonesSchemasAlwaysUseHTTPSValue 

type SettingGetResponseZonesSchemasAlwaysUseHTTPSValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasAlwaysUseHTTPSValue) IsKnown 

func (r SettingGetResponseZonesSchemasAlwaysUseHTTPSValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasAutomaticHTTPSRewritesEditable) IsKnown() bool

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID 

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasAutomaticHTTPSRewritesIDAutomaticHTTPSRewrites SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

func (SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID) IsKnown 

func (r SettingGetResponseZonesSchemasAutomaticHTTPSRewritesID) IsKnown() bool

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue 

type SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue) IsKnown 

func (r SettingGetResponseZonesSchemasAutomaticHTTPSRewritesValue) IsKnown() bool

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 

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

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 

func (r SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown() bool

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID 

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown 

func (r SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown() bool

type SettingGetResponseZonesSchemasBrowserCacheTTL 

type SettingGetResponseZonesSchemasBrowserCacheTTL struct {
	// ID of the zone setting.
	ID SettingGetResponseZonesSchemasBrowserCacheTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value int64 `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 

func (r SettingGetResponseZonesSchemasBrowserCacheTTLEditable) IsKnown() bool

type SettingGetResponseZonesSchemasBrowserCacheTTLID 

type SettingGetResponseZonesSchemasBrowserCacheTTLID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasBrowserCacheTTLIDBrowserCacheTTL SettingGetResponseZonesSchemasBrowserCacheTTLID = "browser_cache_ttl"
)

func (SettingGetResponseZonesSchemasBrowserCacheTTLID) IsKnown 

func (r SettingGetResponseZonesSchemasBrowserCacheTTLID) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasBrowserCheckEditable) IsKnown() bool

type SettingGetResponseZonesSchemasBrowserCheckID 

type SettingGetResponseZonesSchemasBrowserCheckID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasBrowserCheckIDBrowserCheck SettingGetResponseZonesSchemasBrowserCheckID = "browser_check"
)

func (SettingGetResponseZonesSchemasBrowserCheckID) IsKnown 

func (r SettingGetResponseZonesSchemasBrowserCheckID) IsKnown() bool

type SettingGetResponseZonesSchemasBrowserCheckValue 

type SettingGetResponseZonesSchemasBrowserCheckValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasBrowserCheckValue) IsKnown 

func (r SettingGetResponseZonesSchemasBrowserCheckValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasCacheLevelEditable) IsKnown() bool

type SettingGetResponseZonesSchemasCacheLevelID 

type SettingGetResponseZonesSchemasCacheLevelID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasCacheLevelIDCacheLevel SettingGetResponseZonesSchemasCacheLevelID = "cache_level"
)

func (SettingGetResponseZonesSchemasCacheLevelID) IsKnown 

func (r SettingGetResponseZonesSchemasCacheLevelID) IsKnown() bool

type SettingGetResponseZonesSchemasCacheLevelValue 

type SettingGetResponseZonesSchemasCacheLevelValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasCacheLevelValue) IsKnown 

func (r SettingGetResponseZonesSchemasCacheLevelValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasEdgeCacheTTLEditable) IsKnown() bool

type SettingGetResponseZonesSchemasEdgeCacheTTLID 

type SettingGetResponseZonesSchemasEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasEdgeCacheTTLIDEdgeCacheTTL SettingGetResponseZonesSchemasEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingGetResponseZonesSchemasEdgeCacheTTLID) IsKnown 

func (r SettingGetResponseZonesSchemasEdgeCacheTTLID) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasEdgeCacheTTLValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasEmailObfuscationEditable) IsKnown() bool

type SettingGetResponseZonesSchemasEmailObfuscationID 

type SettingGetResponseZonesSchemasEmailObfuscationID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasEmailObfuscationIDEmailObfuscation SettingGetResponseZonesSchemasEmailObfuscationID = "email_obfuscation"
)

func (SettingGetResponseZonesSchemasEmailObfuscationID) IsKnown 

func (r SettingGetResponseZonesSchemasEmailObfuscationID) IsKnown() bool

type SettingGetResponseZonesSchemasEmailObfuscationValue 

type SettingGetResponseZonesSchemasEmailObfuscationValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasEmailObfuscationValue) IsKnown 

func (r SettingGetResponseZonesSchemasEmailObfuscationValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasIPGeolocationEditable) IsKnown() bool

type SettingGetResponseZonesSchemasIPGeolocationID 

type SettingGetResponseZonesSchemasIPGeolocationID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasIPGeolocationIDIPGeolocation SettingGetResponseZonesSchemasIPGeolocationID = "ip_geolocation"
)

func (SettingGetResponseZonesSchemasIPGeolocationID) IsKnown 

func (r SettingGetResponseZonesSchemasIPGeolocationID) IsKnown() bool

type SettingGetResponseZonesSchemasIPGeolocationValue 

type SettingGetResponseZonesSchemasIPGeolocationValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasIPGeolocationValue) IsKnown 

func (r SettingGetResponseZonesSchemasIPGeolocationValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasMirageEditable) IsKnown() bool

type SettingGetResponseZonesSchemasMirageID 

type SettingGetResponseZonesSchemasMirageID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasMirageIDMirage SettingGetResponseZonesSchemasMirageID = "mirage"
)

func (SettingGetResponseZonesSchemasMirageID) IsKnown 

func (r SettingGetResponseZonesSchemasMirageID) IsKnown() bool

type SettingGetResponseZonesSchemasMirageValue 

type SettingGetResponseZonesSchemasMirageValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasMirageValue) IsKnown 

func (r SettingGetResponseZonesSchemasMirageValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasOpportunisticEncryptionEditable) IsKnown() bool

type SettingGetResponseZonesSchemasOpportunisticEncryptionID 

type SettingGetResponseZonesSchemasOpportunisticEncryptionID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasOpportunisticEncryptionIDOpportunisticEncryption SettingGetResponseZonesSchemasOpportunisticEncryptionID = "opportunistic_encryption"
)

func (SettingGetResponseZonesSchemasOpportunisticEncryptionID) IsKnown 

func (r SettingGetResponseZonesSchemasOpportunisticEncryptionID) IsKnown() bool

type SettingGetResponseZonesSchemasOpportunisticEncryptionValue 

type SettingGetResponseZonesSchemasOpportunisticEncryptionValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasOpportunisticEncryptionValue) IsKnown 

func (r SettingGetResponseZonesSchemasOpportunisticEncryptionValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasOriginErrorPagePassThruEditable) IsKnown() bool

type SettingGetResponseZonesSchemasOriginErrorPagePassThruID 

type SettingGetResponseZonesSchemasOriginErrorPagePassThruID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasOriginErrorPagePassThruIDOriginErrorPagePassThru SettingGetResponseZonesSchemasOriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

func (SettingGetResponseZonesSchemasOriginErrorPagePassThruID) IsKnown 

func (r SettingGetResponseZonesSchemasOriginErrorPagePassThruID) IsKnown() bool

type SettingGetResponseZonesSchemasOriginErrorPagePassThruValue 

type SettingGetResponseZonesSchemasOriginErrorPagePassThruValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasOriginErrorPagePassThruValue) IsKnown 

func (r SettingGetResponseZonesSchemasOriginErrorPagePassThruValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasPolishEditable) IsKnown() bool

type SettingGetResponseZonesSchemasPolishID 

type SettingGetResponseZonesSchemasPolishID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasPolishIDPolish SettingGetResponseZonesSchemasPolishID = "polish"
)

func (SettingGetResponseZonesSchemasPolishID) IsKnown 

func (r SettingGetResponseZonesSchemasPolishID) IsKnown() bool

type SettingGetResponseZonesSchemasPolishValue 

type SettingGetResponseZonesSchemasPolishValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasPolishValue) IsKnown 

func (r SettingGetResponseZonesSchemasPolishValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasResponseBufferingEditable) IsKnown() bool

type SettingGetResponseZonesSchemasResponseBufferingID 

type SettingGetResponseZonesSchemasResponseBufferingID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasResponseBufferingIDResponseBuffering SettingGetResponseZonesSchemasResponseBufferingID = "response_buffering"
)

func (SettingGetResponseZonesSchemasResponseBufferingID) IsKnown 

func (r SettingGetResponseZonesSchemasResponseBufferingID) IsKnown() bool

type SettingGetResponseZonesSchemasResponseBufferingValue 

type SettingGetResponseZonesSchemasResponseBufferingValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasResponseBufferingValue) IsKnown 

func (r SettingGetResponseZonesSchemasResponseBufferingValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasRocketLoaderEditable) IsKnown() bool

type SettingGetResponseZonesSchemasRocketLoaderID 

type SettingGetResponseZonesSchemasRocketLoaderID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasRocketLoaderIDRocketLoader SettingGetResponseZonesSchemasRocketLoaderID = "rocket_loader"
)

func (SettingGetResponseZonesSchemasRocketLoaderID) IsKnown 

func (r SettingGetResponseZonesSchemasRocketLoaderID) IsKnown() bool

type SettingGetResponseZonesSchemasRocketLoaderValue 

type SettingGetResponseZonesSchemasRocketLoaderValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasRocketLoaderValue) IsKnown 

func (r SettingGetResponseZonesSchemasRocketLoaderValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasSSLEditable) IsKnown() bool

type SettingGetResponseZonesSchemasSSLID 

type SettingGetResponseZonesSchemasSSLID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasSSLIDSSL SettingGetResponseZonesSchemasSSLID = "ssl"
)

func (SettingGetResponseZonesSchemasSSLID) IsKnown 

func (r SettingGetResponseZonesSchemasSSLID) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasSSLValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasSecurityLevelEditable) IsKnown() bool

type SettingGetResponseZonesSchemasSecurityLevelID 

type SettingGetResponseZonesSchemasSecurityLevelID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasSecurityLevelIDSecurityLevel SettingGetResponseZonesSchemasSecurityLevelID = "security_level"
)

func (SettingGetResponseZonesSchemasSecurityLevelID) IsKnown 

func (r SettingGetResponseZonesSchemasSecurityLevelID) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasSecurityLevelValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasSortQueryStringForCacheEditable) IsKnown() bool

type SettingGetResponseZonesSchemasSortQueryStringForCacheID 

type SettingGetResponseZonesSchemasSortQueryStringForCacheID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasSortQueryStringForCacheIDSortQueryStringForCache SettingGetResponseZonesSchemasSortQueryStringForCacheID = "sort_query_string_for_cache"
)

func (SettingGetResponseZonesSchemasSortQueryStringForCacheID) IsKnown 

func (r SettingGetResponseZonesSchemasSortQueryStringForCacheID) IsKnown() bool

type SettingGetResponseZonesSchemasSortQueryStringForCacheValue 

type SettingGetResponseZonesSchemasSortQueryStringForCacheValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasSortQueryStringForCacheValue) IsKnown 

func (r SettingGetResponseZonesSchemasSortQueryStringForCacheValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasTrueClientIPHeaderEditable) IsKnown() bool

type SettingGetResponseZonesSchemasTrueClientIPHeaderID 

type SettingGetResponseZonesSchemasTrueClientIPHeaderID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasTrueClientIPHeaderIDTrueClientIPHeader SettingGetResponseZonesSchemasTrueClientIPHeaderID = "true_client_ip_header"
)

func (SettingGetResponseZonesSchemasTrueClientIPHeaderID) IsKnown 

func (r SettingGetResponseZonesSchemasTrueClientIPHeaderID) IsKnown() bool

type SettingGetResponseZonesSchemasTrueClientIPHeaderValue 

type SettingGetResponseZonesSchemasTrueClientIPHeaderValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasTrueClientIPHeaderValue) IsKnown 

func (r SettingGetResponseZonesSchemasTrueClientIPHeaderValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSchemasWAFEditable) IsKnown() bool

type SettingGetResponseZonesSchemasWAFID 

type SettingGetResponseZonesSchemasWAFID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasWAFIDWAF SettingGetResponseZonesSchemasWAFID = "waf"
)

func (SettingGetResponseZonesSchemasWAFID) IsKnown 

func (r SettingGetResponseZonesSchemasWAFID) IsKnown() bool

type SettingGetResponseZonesSchemasWAFValue 

type SettingGetResponseZonesSchemasWAFValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSchemasWAFValue) IsKnown 

func (r SettingGetResponseZonesSchemasWAFValue) IsKnown() bool

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 

func (r SettingGetResponseZonesSha1SupportEditable) IsKnown() bool

type SettingGetResponseZonesSha1SupportID 

type SettingGetResponseZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingGetResponseZonesSha1SupportIDSha1Support SettingGetResponseZonesSha1SupportID = "sha1_support"
)

func (SettingGetResponseZonesSha1SupportID) IsKnown 

func (r SettingGetResponseZonesSha1SupportID) IsKnown() bool

type SettingGetResponseZonesSha1SupportValue 

type SettingGetResponseZonesSha1SupportValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSha1SupportValue) IsKnown 

func (r SettingGetResponseZonesSha1SupportValue) IsKnown() bool

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 

func (r SettingGetResponseZonesTLS1_2OnlyEditable) IsKnown() bool

type SettingGetResponseZonesTLS1_2OnlyID 

type SettingGetResponseZonesTLS1_2OnlyID string

Zone setting identifier. 

const (
	SettingGetResponseZonesTLS1_2OnlyIDTLS1_2Only SettingGetResponseZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingGetResponseZonesTLS1_2OnlyID) IsKnown 

func (r SettingGetResponseZonesTLS1_2OnlyID) IsKnown() bool

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 

func (r SettingGetResponseZonesTLS1_2OnlyValue) IsKnown() bool

type SettingGetResponseZonesTransformations 

type SettingGetResponseZonesTransformations struct {
	// ID of the zone setting. Shared between Image Transformations and Video
	// Transformations.
	ID SettingGetResponseZonesTransformationsID `json:"id,required"`
	// Current value of the zone setting.
	Value SettingGetResponseZonesTransformationsValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseZonesTransformationsEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                  `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesTransformationsJSON `json:"-"`
}

Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.

func (*SettingGetResponseZonesTransformations) UnmarshalJSON 

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

type SettingGetResponseZonesTransformationsAllowedOrigins 

type SettingGetResponseZonesTransformationsAllowedOrigins struct {
	// ID of the zone setting. Shared between Image Transformations and Video
	// Transformations.
	ID SettingGetResponseZonesTransformationsAllowedOriginsID `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 SettingGetResponseZonesTransformationsAllowedOriginsEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                                                `json:"modified_on,nullable" format:"date-time"`
	JSON       settingGetResponseZonesTransformationsAllowedOriginsJSON `json:"-"`
}

Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.

func (*SettingGetResponseZonesTransformationsAllowedOrigins) UnmarshalJSON 

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

type SettingGetResponseZonesTransformationsAllowedOriginsEditable 

type SettingGetResponseZonesTransformationsAllowedOriginsEditable bool

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

const (
	SettingGetResponseZonesTransformationsAllowedOriginsEditableTrue  SettingGetResponseZonesTransformationsAllowedOriginsEditable = true
	SettingGetResponseZonesTransformationsAllowedOriginsEditableFalse SettingGetResponseZonesTransformationsAllowedOriginsEditable = false
)

func (SettingGetResponseZonesTransformationsAllowedOriginsEditable) IsKnown 

func (r SettingGetResponseZonesTransformationsAllowedOriginsEditable) IsKnown() bool

type SettingGetResponseZonesTransformationsAllowedOriginsID 

type SettingGetResponseZonesTransformationsAllowedOriginsID string

ID of the zone setting. Shared between Image Transformations and Video Transformations. 

const (
	SettingGetResponseZonesTransformationsAllowedOriginsIDTransformationsAllowedOrigins SettingGetResponseZonesTransformationsAllowedOriginsID = "transformations_allowed_origins"
)

func (SettingGetResponseZonesTransformationsAllowedOriginsID) IsKnown 

func (r SettingGetResponseZonesTransformationsAllowedOriginsID) IsKnown() bool

type SettingGetResponseZonesTransformationsEditable 

type SettingGetResponseZonesTransformationsEditable bool

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

const (
	SettingGetResponseZonesTransformationsEditableTrue  SettingGetResponseZonesTransformationsEditable = true
	SettingGetResponseZonesTransformationsEditableFalse SettingGetResponseZonesTransformationsEditable = false
)

func (SettingGetResponseZonesTransformationsEditable) IsKnown 

func (r SettingGetResponseZonesTransformationsEditable) IsKnown() bool

type SettingGetResponseZonesTransformationsID 

type SettingGetResponseZonesTransformationsID string

ID of the zone setting. Shared between Image Transformations and Video Transformations. 

const (
	SettingGetResponseZonesTransformationsIDTransformations SettingGetResponseZonesTransformationsID = "transformations"
)

func (SettingGetResponseZonesTransformationsID) IsKnown 

func (r SettingGetResponseZonesTransformationsID) IsKnown() bool

type SettingGetResponseZonesTransformationsValue 

type SettingGetResponseZonesTransformationsValue string

Current value of the zone setting. 

const (
	SettingGetResponseZonesTransformationsValueOn   SettingGetResponseZonesTransformationsValue = "on"
	SettingGetResponseZonesTransformationsValueOff  SettingGetResponseZonesTransformationsValue = "off"
	SettingGetResponseZonesTransformationsValueOpen SettingGetResponseZonesTransformationsValue = "open"
)

func (SettingGetResponseZonesTransformationsValue) IsKnown 

func (r SettingGetResponseZonesTransformationsValue) IsKnown() bool

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

func (r SortQueryStringForCache) ImplementsPageRuleAction()

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

func (r SortQueryStringForCacheParam) ImplementsPageRuleEditParamsActionUnion()

func (SortQueryStringForCacheParam) ImplementsPageRuleNewParamsActionUnion 

func (r SortQueryStringForCacheParam) ImplementsPageRuleNewParamsActionUnion()

func (SortQueryStringForCacheParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r SortQueryStringForCacheParam) ImplementsPageRuleUpdateParamsActionUnion()

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 SubscriptionGetParams 

type SubscriptionGetParams struct {
	// Subscription identifier tag.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type SubscriptionGetResponseEnvelope 

type SubscriptionGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   shared.Subscription   `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 

func (r SubscriptionGetResponseEnvelopeSuccess) IsKnown() bool

type SubscriptionNewParams 

type SubscriptionNewParams struct {
	// Subscription identifier tag.
	ZoneID       param.Field[string]      `path:"zone_id,required"`
	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   shared.Subscription   `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 

func (r SubscriptionNewResponseEnvelopeSuccess) IsKnown() bool

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, query SubscriptionGetParams, opts ...option.RequestOption) (res *shared.Subscription, err error)

Lists zone subscription details.

func (*SubscriptionService) New 

func (r *SubscriptionService) New(ctx context.Context, params SubscriptionNewParams, opts ...option.RequestOption) (res *shared.Subscription, err error)

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

func (*SubscriptionService) Update 

func (r *SubscriptionService) Update(ctx context.Context, params SubscriptionUpdateParams, opts ...option.RequestOption) (res *shared.Subscription, 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 identifier tag.
	ZoneID       param.Field[string]      `path:"zone_id,required"`
	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   shared.Subscription   `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 

func (r SubscriptionUpdateResponseEnvelopeSuccess) IsKnown() bool

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_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 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 TokenPolicyResourcesIAMResourcesTypeObjectNested 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

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

func (r TrueClientIPHeader) ImplementsPageRuleAction()

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

func (r TrueClientIPHeaderParam) ImplementsPageRuleEditParamsActionUnion()

func (TrueClientIPHeaderParam) ImplementsPageRuleNewParamsActionUnion 

func (r TrueClientIPHeaderParam) ImplementsPageRuleNewParamsActionUnion()

func (TrueClientIPHeaderParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r TrueClientIPHeaderParam) ImplementsPageRuleUpdateParamsActionUnion()

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"
	TypeInternal  Type = "internal"
)

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

func (r WAF) ImplementsPageRuleAction()

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

func (r WAFParam) ImplementsPageRuleEditParamsActionUnion()

func (WAFParam) ImplementsPageRuleNewParamsActionUnion 

func (r WAFParam) ImplementsPageRuleNewParamsActionUnion()

func (WAFParam) ImplementsPageRuleUpdateParamsActionUnion 

func (r WAFParam) ImplementsPageRuleUpdateParamsActionUnion()

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 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 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 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"`
	// A Zones subscription information.
	//
	// Deprecated: deprecated
	Plan ZonePlan `json:"plan,required"`
	// Allows the customer to use a custom apex. _Tenants Only Configuration_.
	CNAMESuffix string `json:"cname_suffix"`
	// 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"`
	// Legacy permissions based on legacy user membership information.
	//
	// Deprecated: deprecated
	Permissions []string `json:"permissions"`
	// The zone status on Cloudflare.
	Status ZoneStatus `json:"status"`
	// The root organizational unit that this zone belongs to (such as a tenant or
	// organization).
	Tenant ZoneTenant `json:"tenant"`
	// The immediate parent organizational unit that this zone belongs to (such as
	// under a tenant or sub-organization).
	TenantUnit ZoneTenantUnit `json:"tenant_unit"`
	// 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"`
	// Verification key for partial zone setup.
	VerificationKey string   `json:"verification_key"`
	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"`
	// Indicates whether the zone is only using Cloudflare DNS services. A true value
	// means the zone will not receive security or performance benefits.
	Paused param.Field[bool] `json:"paused"`
	// 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"
	ZoneEditParamsTypeInternal  ZoneEditParamsType = "internal"
)

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"`
	// Specify a zone status to filter by.
	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 {
	// Filter by 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"
	ZoneListParamsOrderPlanID      ZoneListParamsOrder = "plan.id"
)

func (ZoneListParamsOrder) IsKnown 

func (r ZoneListParamsOrder) IsKnown() bool

type ZoneListParamsStatus 

type ZoneListParamsStatus string

Specify a zone status to filter by. 

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 ZonePlan deprecated 

type ZonePlan struct {
	// Identifier
	ID string `json:"id"`
	// States if the subscription can be activated.
	CanSubscribe bool `json:"can_subscribe"`
	// The denomination of the customer.
	Currency string `json:"currency"`
	// If this Zone is managed by another company.
	ExternallyManaged bool `json:"externally_managed"`
	// How often the customer is billed.
	Frequency string `json:"frequency"`
	// States if the subscription active.
	IsSubscribed bool `json:"is_subscribed"`
	// If the legacy discount applies to this Zone.
	LegacyDiscount bool `json:"legacy_discount"`
	// The legacy name of the plan.
	LegacyID string `json:"legacy_id"`
	// Name of the owner.
	Name string `json:"name"`
	// How much the customer is paying.
	Price float64      `json:"price"`
	JSON  zonePlanJSON `json:"-"`
}

A Zones subscription information.

Deprecated: deprecated

func (*ZonePlan) UnmarshalJSON 

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

type ZoneService 

type ZoneService struct {
	Options         []option.RequestOption
	ActivationCheck *ActivationCheckService
	Settings        *SettingService
	// Deprecated: Use DNS settings API instead.
	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 

func (r *ZoneService) List(ctx context.Context, query ZoneListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[Zone], err error)

Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed.

func (*ZoneService) ListAutoPaging 

func (r *ZoneService) ListAutoPaging(ctx context.Context, query ZoneListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[Zone]

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

type ZoneTenant 

type ZoneTenant struct {
	// Identifier
	ID string `json:"id"`
	// The name of the Tenant account.
	Name string         `json:"name"`
	JSON zoneTenantJSON `json:"-"`
}

The root organizational unit that this zone belongs to (such as a tenant or organization).

func (*ZoneTenant) UnmarshalJSON 

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

type ZoneTenantUnit 

type ZoneTenantUnit struct {
	// Identifier
	ID   string             `json:"id"`
	JSON zoneTenantUnitJSON `json:"-"`
}

The immediate parent organizational unit that this zone belongs to (such as under a tenant or sub-organization).

func (*ZoneTenantUnit) UnmarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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